-.. GNU MediaGoblin documentation master file, created by
- sphinx-quickstart on Thu Apr 7 20:10:27 2011.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
+.. 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!
===========================================
-Table of Contents:
+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: 2
+ :maxdepth: 1
+
+ siteadmin/foreword
+ siteadmin/about
+ siteadmin/deploying
+ siteadmin/production-deployments
+ siteadmin/configuration
+ siteadmin/media-types
+ siteadmin/help
+ siteadmin/relnotes
+ siteadmin/theming
+ siteadmin/plugins
+ siteadmin/commandline-upload
+
+
+.. _core-plugin-section:
+
+Part 2: Core plugin documentation
+=================================
+
+.. toctree::
+ :maxdepth: 1
+
+ plugindocs/flatpagesfile
+ plugindocs/sampleplugin
+ plugindocs/trim_whitespace
+ plugindocs/raven
+ plugindocs/basic_auth
+ plugindocs/openid
+ plugindocs/persona
+ plugindocs/ldap
+
+
+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
+ pluginwriter/hooks
+ pluginwriter/media_type_hooks
+ pluginwriter/authhooks
+
+
+Part 4: Developer's Zone
+========================
+
+This chapter contains various information for developers.
+
+.. toctree::
+ :maxdepth: 1
+
+ devel/codebase
+ devel/storage
+ devel/originaldesigndecisions
+ devel/migrations
+
+
+Part 5: Pump API
+================
+
+This chapter covers MediaGoblin's `Pump API
+<https://github.com/e14n/pump.io/blob/master/API.md>`_ support. (A
+work in progress; full federation is not supported at the moment, but
+media uploading works! You can use something like
+`PyPump <http://pypump.org>`_
+to write MediaGoblin uploadable applications.)
+
+.. toctree::
+ :maxdepth: 1
+
+ api/client_register
+ api/oauth
+ api/media
+ api/media_interaction
- foreword
- mediagoblin
- contributinghowto
- deploymenthowto
- theminghowto
- git
- codebase
- vision
Indices and tables
==================
-* :ref:`genindex`
-* :ref:`modindex`
* :ref:`search`
+* :ref:`genindex`
+
+.. * :ref:`modindex`
+This guide was built on |today|.
projects / mediagoblin.git / blobdiff