From: Will Kahn-Greene Date: Fri, 15 Apr 2011 02:28:02 +0000 (-0400) Subject: Overhauls TOC of manual X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=5a40e1ec5cb3fc9fe4dbc8078bb45627bf597f72;p=mediagoblin.git Overhauls TOC of manual This work is based on discussion and etherpadding (is that a verb) on April 14th between Deb, Greg, Karen, Will, and Chris. It was an epic collaborative sprint. --- diff --git a/docs/codedocs.rst b/docs/codedocs.rst new file mode 100644 index 00000000..09f91274 --- /dev/null +++ b/docs/codedocs.rst @@ -0,0 +1,5 @@ +==================== + Code Documentation +==================== + +FIXME - stub! diff --git a/docs/contributinghowto.rst b/docs/contributinghowto.rst new file mode 100644 index 00000000..1b34badc --- /dev/null +++ b/docs/contributinghowto.rst @@ -0,0 +1,58 @@ +==================== + Contributing HOWTO +==================== + +We're super glad you want to contribute! + +There are a variety of ways you can help us and become part of the +team. We're not just looking for coders! We're also looking for +documentation writers, users, testers, evangelists, painters, bakers, +candle-stick makers... + +However, if you are a coder and you're looking to code, check out the +:ref:`hacking-howto`. + +The rest of this chapter talks about different things we need your +help with. + +**File bugs** + + Filing bugs is an important part of any project. For more + information on filing bugs, see :ref:`filing-bugs`. + + +**Translate GNU MediaGoblin** + + Knowing more than one language is an important skill. If you are + multi-lingual and are interested in translating GNU MediaGoblin, + see :ref:`translating`. + +FIXME - add additional things here + + +.. _filing-bugs: + +File bugs +========= + +GNU MediaGoblin uses a bug tracker called `Redmine +`. + +The bug tracker is at http://bugs.foocorp.net/ and bugs go in the +``GNU mediagoblin`` project. + +FIXME - how to file a good bug report + + +.. _translating: + +Translate GNU MediaGoblin +========================= + +FIXME - need to write this + + +Where to go when you get stuck +============================== + +FIXME - need to write this diff --git a/docs/foreward.rst b/docs/foreward.rst index 4fc8152a..0a3630a1 100644 --- a/docs/foreward.rst +++ b/docs/foreward.rst @@ -2,17 +2,30 @@ Foreward ========== -What is GNU MediaGoblin -======================= +About this manual +================= -See the web-site at http://mediagoblin.org/ . +This is the GNU MediaGoblin manual. This documentation targets the +following groups of individuals: + +* people who want to use the software +* people who want to deploy the software +* contributors + +This manual is a living document and is in the ``mediagoblin`` +repository in the ``docs/`` directory. Who wrote this documentation ============================ -* Chris Webber -* Will Kahn-Greene +In no particular order: + +* Chris +* Will +* Deb +* Greg +* Karen How should I bring up errors in the documentation diff --git a/docs/hackinghowto.rst b/docs/hackinghowto.rst index 4586188e..986219e1 100644 --- a/docs/hackinghowto.rst +++ b/docs/hackinghowto.rst @@ -1,9 +1,12 @@ +.. _hacking-howto: + =============== Hacking HOWTO =============== -So you want to hack on GNU MediaGoblin -====================================== + +So you want to hack on GNU MediaGoblin? +======================================= First thing to do is check out the Web site where we list all the project infrastructure including: @@ -75,6 +78,8 @@ Run:: Creating a new file =================== +FIXME - this needs to be updated when it's set in stone. + All new files need to have license/copyright information. The following kinds of files get the GNU AGPL header: @@ -93,3 +98,15 @@ under the CC BY license: * image files * video files + + +Quickstart for Django programmers +================================= + +FIXME - write this + + +Bite-sized bugs to start with +============================= + +FIXME - write this diff --git a/docs/index.rst b/docs/index.rst index 965d5d7a..98d37969 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,23 +6,21 @@ Welcome to GNU MediaGoblin's documentation! =========================================== -This documentation covers the GNU MediaGoblin software. It is versioned -alongside the code and the source for this documentation is located in -the mediagoblin repository in the ``docs/`` directory. - -It is also viewable on the Web site in HTML form. - - -Contents: +Table of Contents: .. toctree:: :maxdepth: 2 foreward - softwarestack + mediagoblin deploymenthowto + contributinghowto hackinghowto + theminghowto + softwarestack designdecisions + workflow + codedocs Indices and tables diff --git a/docs/mediagoblin.rst b/docs/mediagoblin.rst new file mode 100644 index 00000000..6c3a8dfa --- /dev/null +++ b/docs/mediagoblin.rst @@ -0,0 +1,63 @@ +================= + GNU MediaGoblin +================= + +What is GNU MediaGoblin +======================= + +Three years ago, a number of free software luminaries got together at +the FSF office to answer the question, "What should software freedom +look like on the participatory web?" Those thinkers included Richard +Stallman - founder of the free software movement and instigator of the +GNU project, Evan Prodromou - the driving force behind Status.net, a +highly sucessful federated micro-blogging service, and FIXME. + +Since that time Identi.ca and Libre.fm have answered the +freedom-loving web-user's need for micro-blogging and music sharing. +Now, GNU MediaGoblin is building a format for users to share photos. +Later versions of MediaGoblin will include support for video and other +media as well as tools to encourage collaboration on media projects. + + +Why are we doing this? +====================== + +Centralization and proprietization of media on the internet is a +serious problem and makes the web go from a system of extreme +resilience to a system of frightening fragility. We believe people +should be able to own their data and that measn someone has to build +the tools to make it possible. We decide that in this case, that +someone would be us! + + +Who are you? +============ + +Free software activists and folks who have worked on a variety of +other projects like Libre.fm, GNU Social, Status.net, Miro, Miro +Community, OpenHatch and other projects as well. We're admirers and +contributors. We're writers and painters. We're friendly and +dedicated to computer user freedom. + + +How can I participate? +====================== + +See `Get Involved `. + + +How is this licensed? +===================== + +FIXME - write this once we work out the details + + +Is this an official GNU Project? What does that mean? +====================================================== + +We are! It means that we meet the GNU Project's rigourous standards +for free software. To find out more about what that means, check out +`the GNU site `. + +Please feel free to contact us with further questions! + diff --git a/docs/theminghowto.rst b/docs/theminghowto.rst new file mode 100644 index 00000000..6ded4ac7 --- /dev/null +++ b/docs/theminghowto.rst @@ -0,0 +1,5 @@ +=============== + Theming HOWTO +=============== + +FIXME - stub! diff --git a/docs/workflow.rst b/docs/workflow.rst index 218a6abd..b72031de 100644 --- a/docs/workflow.rst +++ b/docs/workflow.rst @@ -1,6 +1,12 @@ -======================================================== - Workflow, and other structurally significant braindumps -======================================================== +========================================================================== + Design Document: Workflow, and other structurally significant braindumps +========================================================================== + +.. Note:: + + When we get a wiki, this will get moved there. It's here for now + mostly because we didn't have a better place for it. + This document attempts to describe the envisioned workflow of mediagoblin, from a structural standpoint. For now, *nothing* in this