Split docs into siteadmin and pluginwriter guides
* create initial bits for plugin writer's guide * move siteadmin stuff to site administrator's guide * rework index.rst to support multiple guides * tweak some text * move files into subdirectories I verified that this still works with html and texinfo build targets. There's still a lot of work to do, but this is a good start.
This commit is contained in:
parent
758def22b8
commit
2530ef7a1f
Before Width: | Height: | Size: 47 KiB After Width: | Height: | Size: 47 KiB |
Before Width: | Height: | Size: 160 KiB After Width: | Height: | Size: 160 KiB |
@ -11,29 +11,42 @@
|
|||||||
Dedication along with this software. If not, see
|
Dedication along with this software. If not, see
|
||||||
<http://creativecommons.org/publicdomain/zero/1.0/>.
|
<http://creativecommons.org/publicdomain/zero/1.0/>.
|
||||||
|
|
||||||
.. 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.
|
|
||||||
|
|
||||||
|
===========================================
|
||||||
Welcome to GNU MediaGoblin's documentation!
|
Welcome to GNU MediaGoblin's documentation!
|
||||||
===========================================
|
===========================================
|
||||||
|
|
||||||
Table of Contents:
|
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::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 1
|
||||||
|
|
||||||
foreword
|
siteadmin/foreword
|
||||||
about
|
siteadmin/about
|
||||||
deploying
|
siteadmin/deploying
|
||||||
production-deployments
|
siteadmin/production-deployments
|
||||||
configuration
|
siteadmin/configuration
|
||||||
media-types
|
siteadmin/media-types
|
||||||
help
|
siteadmin/help
|
||||||
relnotes
|
siteadmin/relnotes
|
||||||
theming
|
siteadmin/theming
|
||||||
codebase
|
siteadmin/plugins
|
||||||
|
siteadmin/codebase
|
||||||
|
|
||||||
|
|
||||||
|
Part 2: Plugin Writer's Guide
|
||||||
|
=============================
|
||||||
|
|
||||||
|
This guide covers writing new GNU MediaGoblin plugins.
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
pluginwriter/foreward
|
||||||
|
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
|
43
docs/source/pluginwriter/foreward.rst
Normal file
43
docs/source/pluginwriter/foreward.rst
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
.. 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/>.
|
||||||
|
|
||||||
|
========
|
||||||
|
Foreword
|
||||||
|
========
|
||||||
|
|
||||||
|
About the Plugin Writer's Guide
|
||||||
|
===============================
|
||||||
|
|
||||||
|
This guide covers writing plugins for GNU MediaGoblin. It's very much
|
||||||
|
a work in progress partially because we just started writing it and
|
||||||
|
partially because the plugin API is currently in flux.
|
||||||
|
|
||||||
|
|
||||||
|
Improving the Plugin Writer's Guide
|
||||||
|
===================================
|
||||||
|
|
||||||
|
There are a few ways---please pick whichever method is convenient for
|
||||||
|
you!
|
||||||
|
|
||||||
|
1. Write up a bug report in the bug tracker
|
||||||
|
2. Tell someone on IRC ``#mediagoblin`` on Freenode.
|
||||||
|
3. Write an email to the devel mailing list.
|
||||||
|
|
||||||
|
Information about the bugtracker, IRC and the mailing list is all on
|
||||||
|
the `join page`_.
|
||||||
|
|
||||||
|
.. _join page: http://mediagoblin.org/join/
|
||||||
|
|
||||||
|
Patches are the most helpful, but even feedback on what you think
|
||||||
|
could be improved and how to improve it is also helpful.
|
||||||
|
|
@ -15,12 +15,12 @@
|
|||||||
Foreword
|
Foreword
|
||||||
========
|
========
|
||||||
|
|
||||||
About the MediaGoblin Manual
|
About the Site Administrator's Guide
|
||||||
============================
|
====================================
|
||||||
|
|
||||||
This is the site administrator manual for MediaGoblin. It covers how
|
This is the site administrator manual for GNU MediaGoblin. It covers
|
||||||
to set up and configure MediaGoblin and the kind of information that
|
how to set up and configure MediaGoblin and the kind of information
|
||||||
someone running MediaGoblin would need to know.
|
that someone running MediaGoblin would need to know.
|
||||||
|
|
||||||
We have other documentation at:
|
We have other documentation at:
|
||||||
|
|
||||||
@ -28,8 +28,8 @@ We have other documentation at:
|
|||||||
* http://wiki.mediagoblin.org/ for our contributor/developer-focused wiki
|
* http://wiki.mediagoblin.org/ for our contributor/developer-focused wiki
|
||||||
|
|
||||||
|
|
||||||
Improving the MediaGoblin Manual
|
Improving the Site Administrator's Guide
|
||||||
================================
|
========================================
|
||||||
|
|
||||||
There are a few ways---please pick whichever method is convenient for
|
There are a few ways---please pick whichever method is convenient for
|
||||||
you!
|
you!
|
@ -21,7 +21,7 @@ You can also write your own plugins and additionally find plugins
|
|||||||
elsewhere on the Internet. Once you find a plugin you like, you need
|
elsewhere on the Internet. Once you find a plugin you like, you need
|
||||||
to first install it, then add it to your configuration.
|
to first install it, then add it to your configuration.
|
||||||
|
|
||||||
.. todo:: how do you find plugins on the internet?
|
.. todo: how do you find plugins on the internet?
|
||||||
|
|
||||||
|
|
||||||
Installing plugins
|
Installing plugins
|
Loading…
x
Reference in New Issue
Block a user