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.
This commit is contained in:
Will Kahn-Greene
parent
76c9ea6b5f
commit
5a40e1ec5c
5
docs/codedocs.rst
Normal file
5
docs/codedocs.rst
Normal file
@ -0,0 +1,5 @@
|
||||
====================
|
||||
Code Documentation
|
||||
====================
|
||||
|
||||
FIXME - stub!
|
||||
58
docs/contributinghowto.rst
Normal file
58
docs/contributinghowto.rst
Normal file
@ -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
|
||||
<http://www.redmine.org>`.
|
||||
|
||||
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
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
63
docs/mediagoblin.rst
Normal file
63
docs/mediagoblin.rst
Normal file
@ -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 <http://mediagoblin.org/join/>`.
|
||||
|
||||
|
||||
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 <http://gnu.org/>`.
|
||||
|
||||
Please feel free to contact us with further questions!
|
||||
|
||||
5
docs/theminghowto.rst
Normal file
5
docs/theminghowto.rst
Normal file
@ -0,0 +1,5 @@
|
||||
===============
|
||||
Theming HOWTO
|
||||
===============
|
||||
|
||||
FIXME - stub!
|
||||
@ -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
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user