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    siteadmin/commandline-upload
  48
  49
  50 .. _core-plugin-section:
  51
  52 Part 2: Core plugin documentation
  53 =================================
  54
  55 .. toctree::
  56    :maxdepth: 1
  57
  58    plugindocs/flatpagesfile
  59    plugindocs/sampleplugin
  60    plugindocs/trim_whitespace
  61    plugindocs/raven
  62    plugindocs/basic_auth
  63    plugindocs/openid
  64    plugindocs/persona
  65    plugindocs/ldap
  66
  67
  68 Part 3: Plugin Writer's Guide
  69 =============================
  70
  71 This guide covers writing new GNU MediaGoblin plugins.
  72
  73 .. toctree::
  74    :maxdepth: 1
  75
  76    pluginwriter/foreward
  77    pluginwriter/quickstart
  78    pluginwriter/database
  79    pluginwriter/api
  80    pluginwriter/tests
  81    pluginwriter/hooks
  82    pluginwriter/media_type_hooks
  83    pluginwriter/authhooks
  84
  85
  86 Part 4: Developer's Zone
  87 ========================
  88
  89 This chapter contains various information for developers.
  90
  91 .. toctree::
  92    :maxdepth: 1
  93
  94    devel/codebase
  95    devel/storage
  96    devel/originaldesigndecisions
  97    devel/migrations
  98
  99
 100 Part 5: Pump API
 101 ================
 102
 103 This chapter covers MediaGoblin's `Pump API
 104 <https://github.com/e14n/pump.io/blob/master/API.md>`_ support.  (A
 105 work in progress; full federation is not supported at the moment, but
 106 media uploading works!  You can use something like
 107 `PyPump <http://pypump.org>`_
 108 to write MediaGoblin applications.)
 109
 110 .. toctree::
 111    :maxdepth: 1
 112
 113    api/authentication
 114    api/activities
 115    api/objects
 116
 117
 118
 119 Indices and tables
 120 ==================
 121
 122 * :ref:`search`
 123 * :ref:`genindex`
 124
 125 .. * :ref:`modindex`
 126
 127 This guide was built on |today|.