diff options
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/_static/goblin.png (renamed from docs/source/goblin.png) | bin | 47763 -> 47763 bytes | |||
| -rw-r--r-- | docs/source/_static/snugglygoblin.png (renamed from docs/source/snugglygoblin.png) | bin | 163754 -> 163754 bytes | |||
| -rw-r--r-- | docs/source/index.rst | 47 | ||||
| -rw-r--r-- | docs/source/pluginwriter/foreward.rst | 43 | ||||
| -rw-r--r-- | docs/source/siteadmin/about.rst (renamed from docs/source/about.rst) | 0 | ||||
| -rw-r--r-- | docs/source/siteadmin/codebase.rst (renamed from docs/source/codebase.rst) | 0 | ||||
| -rw-r--r-- | docs/source/siteadmin/configuration.rst (renamed from docs/source/configuration.rst) | 0 | ||||
| -rw-r--r-- | docs/source/siteadmin/deploying.rst (renamed from docs/source/deploying.rst) | 0 | ||||
| -rw-r--r-- | docs/source/siteadmin/foreword.rst (renamed from docs/source/foreword.rst) | 14 | ||||
| -rw-r--r-- | docs/source/siteadmin/help.rst (renamed from docs/source/help.rst) | 0 | ||||
| -rw-r--r-- | docs/source/siteadmin/media-types.rst (renamed from docs/source/media-types.rst) | 0 | ||||
| -rw-r--r-- | docs/source/siteadmin/plugins.rst (renamed from docs/source/plugins.rst) | 2 | ||||
| -rw-r--r-- | docs/source/siteadmin/production-deployments.rst (renamed from docs/source/production-deployments.rst) | 0 | ||||
| -rw-r--r-- | docs/source/siteadmin/relnotes.rst (renamed from docs/source/relnotes.rst) | 0 | ||||
| -rw-r--r-- | docs/source/siteadmin/theming.rst (renamed from docs/source/theming.rst) | 0 |
15 files changed, 81 insertions, 25 deletions
diff --git a/docs/source/goblin.png b/docs/source/_static/goblin.png Binary files differindex e20265e6..e20265e6 100644 --- a/docs/source/goblin.png +++ b/docs/source/_static/goblin.png diff --git a/docs/source/snugglygoblin.png b/docs/source/_static/snugglygoblin.png Binary files differindex f325ae4b..f325ae4b 100644 --- a/docs/source/snugglygoblin.png +++ b/docs/source/_static/snugglygoblin.png diff --git a/docs/source/index.rst b/docs/source/index.rst index 187a0382..dc8bacc7 100644 --- 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 index 00000000..fd3a0c22 --- /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 index 95647abb..95647abb 100644 --- a/docs/source/about.rst +++ b/docs/source/siteadmin/about.rst diff --git a/docs/source/codebase.rst b/docs/source/siteadmin/codebase.rst index 3ef91290..3ef91290 100644 --- a/docs/source/codebase.rst +++ b/docs/source/siteadmin/codebase.rst diff --git a/docs/source/configuration.rst b/docs/source/siteadmin/configuration.rst index a3dafa4c..a3dafa4c 100644 --- a/docs/source/configuration.rst +++ b/docs/source/siteadmin/configuration.rst diff --git a/docs/source/deploying.rst b/docs/source/siteadmin/deploying.rst index 788b06d7..788b06d7 100644 --- a/docs/source/deploying.rst +++ b/docs/source/siteadmin/deploying.rst diff --git a/docs/source/foreword.rst b/docs/source/siteadmin/foreword.rst index 39ece25d..4c425f8d 100644 --- 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 index 4b584ac1..4b584ac1 100644 --- a/docs/source/help.rst +++ b/docs/source/siteadmin/help.rst diff --git a/docs/source/media-types.rst b/docs/source/siteadmin/media-types.rst index 1cf7f30c..1cf7f30c 100644 --- a/docs/source/media-types.rst +++ b/docs/source/siteadmin/media-types.rst diff --git a/docs/source/plugins.rst b/docs/source/siteadmin/plugins.rst index dfb69075..41f2970f 100644 --- 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 index 1e6631db..1e6631db 100644 --- a/docs/source/production-deployments.rst +++ b/docs/source/siteadmin/production-deployments.rst diff --git a/docs/source/relnotes.rst b/docs/source/siteadmin/relnotes.rst index 2efded73..2efded73 100644 --- a/docs/source/relnotes.rst +++ b/docs/source/siteadmin/relnotes.rst diff --git a/docs/source/theming.rst b/docs/source/siteadmin/theming.rst index 7584b688..7584b688 100644 --- a/docs/source/theming.rst +++ b/docs/source/siteadmin/theming.rst |
