heckyel/mediagoblin
0
0
Fork 0
Code Issues Pull Requests Releases Activity

Documentation Revision, clarification, and editing.

Browse Source 
- a line in the .gitignore file to ignore the built documentation
  tree.

- a complete revision/editorial pass of all non-technical documents
  that outline process, project fundamentals, and background. These
  edits clarified the text, unified the style, and elaborated on
  stubs.
This commit is contained in:
tycho garen
2011-08-27 17:43:14 -04:00
parent 7d6a9058dd
commit 6503d66c98
5 changed files with 224 additions and 176 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
docs/source/foreword.rst
View File

@@ -1,39 +1,46 @@
==========
Foreword
==========
========
Foreword
========
About this manual
=================
About the MediaGoblin Manual
============================
This is the GNU MediaGoblin manual. This documentation targets the
following groups of individuals:
Welcome to the GNU MediaGoblin manual. This document targets several
classes of users, including:
* people who want to try the software locally
* people who want to deploy and administrate the software
* users who would like to try the software locally,
* systems administrators who want to deploy and administer the
software in "production environments," and
* anyone who wants to learn how MediaGoblin works.
This manual doesn't cover contributors to the codebase. But we want
and love contributors! To join as a contributor please visit the
following pages instead:
Some information relevant to the MediaGoblin community members,
including how to get involved (We want and love contributors!) To join
as a contributor please see the following pages:
* http://mediagoblin.org/pages/join.html for general "join us" information
* http://wiki.mediagoblin.org/ for our contributor-focused wiki
If you are viewing this from http://docs.mediagoblin.org be aware that
this manual is a living document and is in the ``mediagoblin``
repository in the ``docs/`` directory.
If you suspect that documentation on http://docs.mediagoblin.org is
out of date, it might be. The documentation is updated regularly and
the "living" version of this resource resides in the ``mediagoblin``
repository with the project's source code the ``docs/`` directory.
Improving the MediaGobiin Manual
================================
I found an error in the docs---who do I tell?
=============================================
There are a few ways---please pick the one most convenient to you!
There are a few ways---please pick whichever method is convenient for
you!
1. Write up a bug report in the bug tracker at http://bugs.foocorp.net/projects/mediagoblin/issues
2. Tell someone on IRC ``#mediagoblin`` on Freenode.
3. Send an email to Will ``willg at bluesock dot org``.
3. Send an email to Will ``willg at bluesock dot org``, or Sam at
``sam@cyborginstitute.com``
When you tell us about your issue, please let us know:
* where you are looking (in git? url of the web-page?)
* what the issue is
* your thoughts on how to resolve it
* what the issue is, and
* your thoughts on how to resolve it.
We hope these materials are useful and we look forward to any and all
feedback.