docs/source/index.rst

   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
  14
  15 ===========================================
  16 Welcome to GNU MediaGoblin's documentation!
  17 ===========================================
  18
  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
  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.
  33
  34 .. toctree::
  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
  48
  49 .. _core-plugin-section:
  50
  51 Part 2: Core plugin documentation
  52 =================================
  53
  54 .. toctree::
  55    :maxdepth: 1
  56
  57    plugindocs/flatpagesfile
  58    plugindocs/sampleplugin
  59    plugindocs/trim_whitespace
  60    plugindocs/raven
  61    plugindocs/basic_auth
  62    plugindocs/openid
  63    plugindocs/persona
  64
  65
  66 Part 3: Plugin Writer's Guide
  67 =============================
  68
  69 This guide covers writing new GNU MediaGoblin plugins.
  70
  71 .. toctree::
  72    :maxdepth: 1
  73
  74    pluginwriter/foreward
  75    pluginwriter/quickstart
  76    pluginwriter/database
  77    pluginwriter/api
  78    pluginwriter/tests
  79    pluginwriter/media_type_hooks
  80    pluginwriter/authhooks
  81
  82
  83 Part 4: Developer's Zone
  84 ========================
  85
  86 This chapter contains various information for developers.
  87
  88 .. toctree::
  89    :maxdepth: 1
  90
  91    devel/codebase
  92    devel/storage
  93    devel/originaldesigndecisions
  94    devel/migrations
  95
  96
  97 Indices and tables
  98 ==================
  99
 100 * :ref:`search`
 101 * :ref:`genindex`
 102
 103 .. * :ref:`modindex`
 104
 105 This guide was built on |today|.