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.

diff --git a/docs/source/goblin.png b/docs/source/_static/goblin.png
similarity index 100%
rename from docs/source/goblin.png
rename to docs/source/_static/goblin.png

diff --git a/docs/source/snugglygoblin.png b/docs/source/_static/snugglygoblin.png
similarity index 100%
rename from docs/source/snugglygoblin.png
rename to docs/source/_static/snugglygoblin.png

diff --git a/docs/source/index.rst b/docs/source/index.rst
index 187a03821c2539cbc90d9022ded7d0e0542086d2..dc8bacc719b8c3815366ba15f0c1c64645f85e74 100644 (file)
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -11,29 +11,42 @@
    Dedication along with this software. If not, see
    <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!
 ===========================================
 
-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::
-   :maxdepth: 2
-
-   foreword
-   about
-   deploying
-   production-deployments
-   configuration
-   media-types
-   help
-   relnotes
-   theming
-   codebase
+   :maxdepth: 1
+
+   siteadmin/foreword
+   siteadmin/about
+   siteadmin/deploying
+   siteadmin/production-deployments
+   siteadmin/configuration
+   siteadmin/media-types
+   siteadmin/help
+   siteadmin/relnotes
+   siteadmin/theming
+   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

diff --git a/docs/source/pluginwriter/foreward.rst b/docs/source/pluginwriter/foreward.rst
new file mode 100644 (file)
index 0000000..fd3a0c2
--- /dev/null
+++ b/docs/source/pluginwriter/foreward.rst
@@ -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.
+

diff --git a/docs/source/about.rst b/docs/source/siteadmin/about.rst
similarity index 100%
rename from docs/source/about.rst
rename to docs/source/siteadmin/about.rst

diff --git a/docs/source/codebase.rst b/docs/source/siteadmin/codebase.rst
similarity index 100%
rename from docs/source/codebase.rst
rename to docs/source/siteadmin/codebase.rst

diff --git a/docs/source/configuration.rst b/docs/source/siteadmin/configuration.rst
similarity index 100%
rename from docs/source/configuration.rst
rename to docs/source/siteadmin/configuration.rst

diff --git a/docs/source/deploying.rst b/docs/source/siteadmin/deploying.rst
similarity index 100%
rename from docs/source/deploying.rst
rename to docs/source/siteadmin/deploying.rst

diff --git a/docs/source/foreword.rst b/docs/source/siteadmin/foreword.rst
similarity index 76%
rename from docs/source/foreword.rst
rename to docs/source/siteadmin/foreword.rst
index 39ece25da7f0c4361af06193057fb19a31292523..4c425f8df209724516c5e646eb74ccabc2a51685 100644 (file)
--- a/docs/source/foreword.rst
+++ b/docs/source/siteadmin/foreword.rst
@@ -15,12 +15,12 @@
 Foreword
 ========
 
-About the MediaGoblin Manual
-============================
+About the Site Administrator's Guide
+====================================
 
-This is the site administrator manual for MediaGoblin.  It covers how
-to set up and configure MediaGoblin and the kind of information that
-someone running MediaGoblin would need to know.
+This is the site administrator manual for GNU MediaGoblin.  It covers
+how to set up and configure MediaGoblin and the kind of information
+that someone running MediaGoblin would need to know.
 
 We have other documentation at:
 
@@ -28,8 +28,8 @@ We have other documentation at:
 * 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
 you!

diff --git a/docs/source/help.rst b/docs/source/siteadmin/help.rst
similarity index 100%
rename from docs/source/help.rst
rename to docs/source/siteadmin/help.rst

diff --git a/docs/source/media-types.rst b/docs/source/siteadmin/media-types.rst
similarity index 100%
rename from docs/source/media-types.rst
rename to docs/source/siteadmin/media-types.rst

diff --git a/docs/source/plugins.rst b/docs/source/siteadmin/plugins.rst
similarity index 98%
rename from docs/source/plugins.rst
rename to docs/source/siteadmin/plugins.rst
index dfb69075186f4be0bb4170c2aea118db966f9af8..41f2970f5e3806affc39a1fdbf534e311ffa912b 100644 (file)
--- a/docs/source/plugins.rst
+++ b/docs/source/siteadmin/plugins.rst
@@ -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
 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

diff --git a/docs/source/production-deployments.rst b/docs/source/siteadmin/production-deployments.rst
similarity index 100%
rename from docs/source/production-deployments.rst
rename to docs/source/siteadmin/production-deployments.rst

diff --git a/docs/source/relnotes.rst b/docs/source/siteadmin/relnotes.rst
similarity index 100%
rename from docs/source/relnotes.rst
rename to docs/source/siteadmin/relnotes.rst

diff --git a/docs/source/theming.rst b/docs/source/siteadmin/theming.rst
similarity index 100%
rename from docs/source/theming.rst
rename to docs/source/siteadmin/theming.rst