aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWill Kahn-Greene <willg@bluesock.org>2011-04-12 22:36:19 -0400
committerWill Kahn-Greene <willg@bluesock.org>2011-04-12 22:36:19 -0400
commit56d507b60bf2393dbeed8b81524b6b922dbc6ad0 (patch)
treefd93bb32adb8bb5ff26b71948d1ac02a8ff34092
parent5698a579b2a9c99729f915f0590c798ca36d279b (diff)
downloadmediagoblin-56d507b60bf2393dbeed8b81524b6b922dbc6ad0.tar.lz
mediagoblin-56d507b60bf2393dbeed8b81524b6b922dbc6ad0.tar.xz
mediagoblin-56d507b60bf2393dbeed8b81524b6b922dbc6ad0.zip
Adds documentation.
* wrote up some basic bits of a hacking howto * added a better deployment howto stub
-rw-r--r--docs/deploymenthowto.rst6
-rw-r--r--docs/hackinghowto.rst88
2 files changed, 92 insertions, 2 deletions
diff --git a/docs/deploymenthowto.rst b/docs/deploymenthowto.rst
index 64baf5c8..39cf73af 100644
--- a/docs/deploymenthowto.rst
+++ b/docs/deploymenthowto.rst
@@ -2,4 +2,8 @@
Deployment HOWTO
==================
-FIXME - write this!
+Step 1: Write code that can be deployed.
+
+Step 2: ?
+
+Step 3: Write the deployment guide and profit!
diff --git a/docs/hackinghowto.rst b/docs/hackinghowto.rst
index 93cd5ddc..8356f435 100644
--- a/docs/hackinghowto.rst
+++ b/docs/hackinghowto.rst
@@ -2,4 +2,90 @@
Hacking HOWTO
===============
-FIXME - write this!
+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:
+
+* the mailing list
+* the IRC channel
+* the bug tracker
+
+Additionally, we have information on how to get involved, who to talk
+to, what needs to be worked on, and other things besides!
+
+
+How to set up an environment for hacking
+========================================
+
+The following assumes you have these things installed:
+
+1. virtualenv:
+
+ http://pypi.python.org/pypi/virtualenv
+
+2. virtualenv wrapper:
+
+ http://www.doughellmann.com/projects/virtualenvwrapper/
+
+3. git:
+
+ http://git-scm.com/
+
+
+Follow these steps:
+
+1. clone the repository::
+
+ git clone http://git.gitorious.org/mediagoblin/mediagoblin.git
+
+2. create a virtual environment::
+
+ mkvirtualenv mediagoblin
+
+3. if that doesn't put you in the virtual environment you created,
+ then do::
+
+ workon mediagoblin
+
+4. run::
+
+ python setup.py develop
+
+
+When you want to work on GNU MediaGoblin, make sure to enter your
+virtual environment::
+
+ workon mediagoblin
+
+Any changes you make to the code will show up in your virtual
+environment--there's no need to continuously run ``python setup.py
+develop``.
+
+
+Running the test suite
+======================
+
+Run::
+
+ python setup.py test
+
+
+Creating a new file
+===================
+
+All new files need to have the standard GNU MediaGoblin
+license/copyright header.
+
+For Python files, include the license/copyright header at the top such
+that each line of the header starts with ``#``.
+
+For Jinja2 template files, FIXME.
+
+For JavaScript files, FIXME.
+
+For CSS files, FIXME.
+
+If you're doing the copy-paste thing, make sure to update the
+copyright year.