Start for documenting core hooks.

[mediagoblin.git] / docs / source / index.rst

diff --git a/docs/source/index.rst b/docs/source/index.rst
index dc8bacc719b8c3815366ba15f0c1c64645f85e74..8e49d1d1d9cba5bc1c1bc696dbf49d1be97958e5 100644 (file)
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -16,6 +16,15 @@
 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
 ==================================
 
@@ -35,10 +44,28 @@ MediaGoblin website.  It is written for site administrators.
    siteadmin/relnotes
    siteadmin/theming
    siteadmin/plugins
-   siteadmin/codebase
+   siteadmin/commandline-upload
+
 
+.. _core-plugin-section:
 
-Part 2: Plugin Writer's Guide
+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.
@@ -47,6 +74,47 @@ This guide covers writing new GNU MediaGoblin plugins.
    :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
+
 
 
 Indices and tables
@@ -57,3 +125,4 @@ Indices and tables
 
 .. * :ref:`modindex`
 
+This guide was built on |today|.