Add Trim whitespace plugin docs.
[mediagoblin.git] / docs / source / index.rst
CommitLineData
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
16Welcome to GNU MediaGoblin's documentation!
17===========================================
18
0e60e7e8
WKG
19GNU MediaGoblin is a platform for sharing photos, video and other media
20in an environment that respects our freedom and independence.
21
22This is a Free Software project. It is built by contributors for all
23to use and enjoy. If you're intrested in contributing, see `the wiki
24<http://wiki.mediagoblin.org/>`_ which has pages that talk about the
25ways someone can contribute.
26
27
2530ef7a
WKG
28Part 1: Site Administrator's Guide
29==================================
30
31This guide covers installing, configuring, deploying and running a GNU
32MediaGoblin 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
47 siteadmin/codebase
48
49
9e579cde
WKG
50.. _core-plugin-section:
51
4bd65f69
WKG
52Part 2: Core plugin documentation
53=================================
54
55.. toctree::
56 :maxdepth: 1
57
58 plugindocs/flatpagesfile
59 plugindocs/sampleplugin
df3147b9 60 plugindocs/oauth
b238a954 61 plugindocs/trim_whitespace
4bd65f69
WKG
62
63
64Part 3: Plugin Writer's Guide
2530ef7a
WKG
65=============================
66
67This guide covers writing new GNU MediaGoblin plugins.
68
69.. toctree::
70 :maxdepth: 1
71
72 pluginwriter/foreward
469f10e4 73 pluginwriter/quickstart
92c597ca 74 pluginwriter/api
8736b05d
WKG
75
76
3eae167e
WKG
77Indices and tables
78==================
79
3eae167e 80* :ref:`search`
6503d66c 81* :ref:`genindex`
82
83.. * :ref:`modindex`
3eae167e 84
4f94f29d 85This guide was built on |today|.