projects / mediagoblin.git / blame
| Commit | Line | Data |
|---|---|---|
| 473a4431 CAW |
1 | .. MediaGoblin Documentation |
| 2 | ||
| 3 | Written in 2011, 2012 by MediaGoblin contributors | |
| 4 | ||
| 5 | To the extent possible under law, the author(s) have dedicated all | |
| 6 | copyright and related and neighboring rights to this software to | |
| 7 | the public domain worldwide. This software is distributed without | |
| 8 | any warranty. | |
| 9 | ||
| 10 | You should have received a copy of the CC0 Public Domain | |
| 11 | Dedication along with this software. If not, see | |
| 12 | <http://creativecommons.org/publicdomain/zero/1.0/>. | |
| 13 | ||
| 3eae167e | 14 | |
| 2530ef7a | 15 | =========================================== |
| 3eae167e WKG |
16 | Welcome to GNU MediaGoblin's documentation! |
| 17 | =========================================== | |
| 18 | ||
| 0e60e7e8 WKG |
19 | GNU MediaGoblin is a platform for sharing photos, video and other media |
| 20 | in an environment that respects our freedom and independence. | |
| 21 | ||
| 22 | This is a Free Software project. It is built by contributors for all | |
| 23 | to use and enjoy. If you're intrested in contributing, see `the wiki | |
| 24 | <http://wiki.mediagoblin.org/>`_ which has pages that talk about the | |
| 25 | ways someone can contribute. | |
| 26 | ||
| 27 | ||
| 2530ef7a WKG |
28 | Part 1: Site Administrator's Guide |
| 29 | ================================== | |
| 30 | ||
| 31 | This guide covers installing, configuring, deploying and running a GNU | |
| 32 | MediaGoblin website. It is written for site administrators. | |
| 3eae167e WKG |
33 | |
| 34 | .. toctree:: | |
| 2530ef7a WKG |
35 | :maxdepth: 1 |
| 36 | ||
| 37 | siteadmin/foreword | |
| 38 | siteadmin/about | |
| 39 | siteadmin/deploying | |
| 40 | siteadmin/production-deployments | |
| 41 | siteadmin/configuration | |
| 42 | siteadmin/media-types | |
| 43 | siteadmin/help | |
| 44 | siteadmin/relnotes | |
| 45 | siteadmin/theming | |
| 46 | siteadmin/plugins | |
| a442823b | 47 | siteadmin/commandline-upload |
| 2530ef7a WKG |
48 | |
| 49 | ||
| 9e579cde WKG |
50 | .. _core-plugin-section: |
| 51 | ||
| 4bd65f69 WKG |
52 | Part 2: Core plugin documentation |
| 53 | ================================= | |
| 54 | ||
| 55 | .. toctree:: | |
| 56 | :maxdepth: 1 | |
| 57 | ||
| 58 | plugindocs/flatpagesfile | |
| 59 | plugindocs/sampleplugin | |
| b238a954 | 60 | plugindocs/trim_whitespace |
| 35f1f759 | 61 | plugindocs/raven |
| bd0ece05 RE |
62 | plugindocs/basic_auth |
| 63 | plugindocs/openid | |
| 26d2cce8 | 64 | plugindocs/persona |
| 994e70e8 | 65 | plugindocs/ldap |
| 4bd65f69 WKG |
66 | |
| 67 | ||
| 68 | Part 3: Plugin Writer's Guide | |
| 2530ef7a WKG |
69 | ============================= |
| 70 | ||
| 71 | This guide covers writing new GNU MediaGoblin plugins. | |
| 72 | ||
| 73 | .. toctree:: | |
| 74 | :maxdepth: 1 | |
| 75 | ||
| 76 | pluginwriter/foreward | |
| 469f10e4 | 77 | pluginwriter/quickstart |
| ae9f0aec | 78 | pluginwriter/database |
| 92c597ca | 79 | pluginwriter/api |
| 25aad338 | 80 | pluginwriter/tests |
| 91bee92e | 81 | pluginwriter/media_type_hooks |
| d194770d | 82 | pluginwriter/authhooks |
| 8736b05d WKG |
83 | |
| 84 | ||
| 3214c653 E |
85 | Part 4: Developer's Zone |
| 86 | ======================== | |
| 87 | ||
| 88 | This chapter contains various information for developers. | |
| 89 | ||
| 90 | .. toctree:: | |
| 91 | :maxdepth: 1 | |
| 92 | ||
| 93 | devel/codebase | |
| 340100ee | 94 | devel/storage |
| 43a2f7fe | 95 | devel/originaldesigndecisions |
| 4436fbcd | 96 | devel/migrations |
| 3214c653 E |
97 | |
| 98 | ||
| 3eae167e WKG |
99 | Indices and tables |
| 100 | ================== | |
| 101 | ||
| 3eae167e | 102 | * :ref:`search` |
| 6503d66c | 103 | * :ref:`genindex` |
| 104 | ||
| 105 | .. * :ref:`modindex` | |
| 3eae167e | 106 | |
| 4f94f29d | 107 | This guide was built on |today|. |