diff options
Diffstat (limited to 'docs/source/index.rst')
-rw-r--r-- | docs/source/index.rst | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 00000000..d71f39f8 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,100 @@ +.. MediaGoblin Documentation + + Written in 2011, 2012 by MediaGoblin contributors + + To the extent possible under law, the author(s) have dedicated all + copyright and related and neighboring rights to this software to + the public domain worldwide. This software is distributed without + any warranty. + + You should have received a copy of the CC0 Public Domain + Dedication along with this software. If not, see + <http://creativecommons.org/publicdomain/zero/1.0/>. + + +=========================================== +Welcome to GNU MediaGoblin's documentation! +=========================================== + +GNU MediaGoblin is a platform for sharing photos, video and other media +in an environment that respects our freedom and independence. + +This is a Free Software project. It is built by contributors for all +to use and enjoy. If you're intrested in contributing, see `the wiki +<http://wiki.mediagoblin.org/>`_ which has pages that talk about the +ways someone can contribute. + + +Part 1: Site Administrator's Guide +================================== + +This guide covers installing, configuring, deploying and running a GNU +MediaGoblin website. It is written for site administrators. + +.. toctree:: + :maxdepth: 1 + + siteadmin/foreword + siteadmin/about + siteadmin/deploying + siteadmin/production-deployments + siteadmin/configuration + siteadmin/media-types + siteadmin/help + siteadmin/relnotes + siteadmin/theming + siteadmin/plugins + + +.. _core-plugin-section: + +Part 2: Core plugin documentation +================================= + +.. toctree:: + :maxdepth: 1 + + plugindocs/flatpagesfile + plugindocs/sampleplugin + plugindocs/oauth + plugindocs/trim_whitespace + plugindocs/raven + + +Part 3: Plugin Writer's Guide +============================= + +This guide covers writing new GNU MediaGoblin plugins. + +.. toctree:: + :maxdepth: 1 + + pluginwriter/foreward + pluginwriter/quickstart + pluginwriter/database + pluginwriter/api + pluginwriter/tests + + +Part 4: Developer's Zone +======================== + +This chapter contains various information for developers. + +.. toctree:: + :maxdepth: 1 + + devel/codebase + devel/storage + devel/originaldesigndecisions + + +Indices and tables +================== + +* :ref:`search` +* :ref:`genindex` + +.. * :ref:`modindex` + +This guide was built on |today|. |