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 | |
2530ef7a WKG |
47 | |
48 | ||
9e579cde WKG |
49 | .. _core-plugin-section: |
50 | ||
4bd65f69 WKG |
51 | Part 2: Core plugin documentation |
52 | ================================= | |
53 | ||
54 | .. toctree:: | |
55 | :maxdepth: 1 | |
56 | ||
57 | plugindocs/flatpagesfile | |
58 | plugindocs/sampleplugin | |
b238a954 | 59 | plugindocs/trim_whitespace |
35f1f759 | 60 | plugindocs/raven |
bd0ece05 RE |
61 | plugindocs/basic_auth |
62 | plugindocs/openid | |
26d2cce8 | 63 | plugindocs/persona |
994e70e8 | 64 | plugindocs/ldap |
4bd65f69 WKG |
65 | |
66 | ||
67 | Part 3: Plugin Writer's Guide | |
2530ef7a WKG |
68 | ============================= |
69 | ||
70 | This guide covers writing new GNU MediaGoblin plugins. | |
71 | ||
72 | .. toctree:: | |
73 | :maxdepth: 1 | |
74 | ||
75 | pluginwriter/foreward | |
469f10e4 | 76 | pluginwriter/quickstart |
ae9f0aec | 77 | pluginwriter/database |
92c597ca | 78 | pluginwriter/api |
25aad338 | 79 | pluginwriter/tests |
91bee92e | 80 | pluginwriter/media_type_hooks |
d194770d | 81 | pluginwriter/authhooks |
8736b05d WKG |
82 | |
83 | ||
3214c653 E |
84 | Part 4: Developer's Zone |
85 | ======================== | |
86 | ||
87 | This chapter contains various information for developers. | |
88 | ||
89 | .. toctree:: | |
90 | :maxdepth: 1 | |
91 | ||
92 | devel/codebase | |
340100ee | 93 | devel/storage |
43a2f7fe | 94 | devel/originaldesigndecisions |
4436fbcd | 95 | devel/migrations |
3214c653 E |
96 | |
97 | ||
3eae167e WKG |
98 | Indices and tables |
99 | ================== | |
100 | ||
3eae167e | 101 | * :ref:`search` |
6503d66c | 102 | * :ref:`genindex` |
103 | ||
104 | .. * :ref:`modindex` | |
3eae167e | 105 | |
4f94f29d | 106 | This guide was built on |today|. |