3214c653dd
We need some "Part" for developers. Currently, it's named "Part 4: Developer's Zone". But we should come up with a better name soon. Moved the codebase docs in there for starters.
96 lines
2.1 KiB
ReStructuredText
96 lines
2.1 KiB
ReStructuredText
.. 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
|
|
|
|
|
|
Part 3: Plugin Writer's Guide
|
|
=============================
|
|
|
|
This guide covers writing new GNU MediaGoblin plugins.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
pluginwriter/foreward
|
|
pluginwriter/quickstart
|
|
pluginwriter/api
|
|
|
|
|
|
Part 4: Developer's Zone
|
|
========================
|
|
|
|
This chapter contains various information for developers.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
devel/codebase
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`search`
|
|
* :ref:`genindex`
|
|
|
|
.. * :ref:`modindex`
|
|
|
|
This guide was built on |today|.
|