Moving translations to mediagoblin/translations

[mediagoblin.git] / docs / hackinghowto.rst

diff --git a/docs/hackinghowto.rst b/docs/hackinghowto.rst
index 73522ec609ae68e1ef8523ebe0703205628a8e83..b34ce93a91d1095e02e5c77ea6629c20904b6987 100644 (file)
--- a/docs/hackinghowto.rst
+++ b/docs/hackinghowto.rst
@@ -28,8 +28,8 @@ Third you'll need to :ref:`get the requirements
 
 Fourth, you'll need to build a development environment.  For this step, there are two options: 
 
-1. :ref:`virtualenv <hacking-with-virtualenv>` OR
-2. :ref:`buildout and bootstrap <hacking-with-buildout>`
+1. :ref:`buildout and bootstrap <hacking-with-buildout>` (easier) OR
+2. :ref:`virtualenv <hacking-with-virtualenv>` (more flexible, but harder)
 
 Pick one---don't do both!
 
@@ -63,6 +63,72 @@ requirements::
    up requirements, let us know!
 
 
+.. _hacking-with-buildout:
+
+How to set up and maintain an environment for hacking with buildout
+===================================================================
+
+.. Note::
+
+   Either follow the instructions in this section OR follow the ones
+   in :ref:`hacking-with-virtualenv`.  But don't do both!
+
+
+**Requirements**
+
+No additional requirements.
+
+
+**Create a development environment**
+
+After installing the requirements, follow these steps:
+
+1. Clone the repository::
+
+       git clone http://git.gitorious.org/mediagoblin/mediagoblin.git
+
+2. Bootstrap and run buildout::
+
+       cd mediagoblin
+       python bootstrap.py && ./bin/buildout
+
+
+That's it!  Using this method, buildout should create a ``user_dev``
+directory, in which certain things will be stored (media, beaker
+session stuff, etc).  You can change this, but for development
+purposes this default should be fine.
+
+
+**Updating for dependency changes**
+
+While hacking on GNU MediaGoblin over time, you'll eventually have to
+update your development environment because the dependencies have
+changed.  To do that, run::
+
+    ./bin/buildout
+
+
+**Updating for code changes**
+
+You don't need to do anything---code changes are automatically
+available.
+
+
+**Deleting your buildout**
+
+At some point, you may want to delete your buildout.  Perhaps it's to
+start over.  Perhaps it's to test building development environments
+with buildout.
+
+To do this, do::
+
+    rm -rf bin develop-eggs eggs mediagoblin.egg-info parts user_dev
+
+Usually buildout works pretty great and is super easy, but if you get
+problems with python-dateutil conflicts on your system, you may need
+to use virtualenv instead.
+
+
 .. _hacking-with-virtualenv:
 
 How to set up and maintain an environment for hacking with virtualenv
@@ -146,79 +212,16 @@ To do this, do::
     rmvirtualenv mediagoblin
 
 
-.. _hacking-with-buildout:
-
-How to set up and maintain an environment for hacking with buildout
-===================================================================
-
-.. Note::
-
-   Either follow the instructions in this section OR follow the ones
-   in :ref:`hacking-with-virtualenv`.  But don't do both!
-
-
-**Requirements**
-
-No additional requirements.
-
-
-**Create a development environment**
-
-After installing the requirements, follow these steps:
-
-1. Clone the repository::
-
-       git clone http://git.gitorious.org/mediagoblin/mediagoblin.git
-
-2. Bootstrap and run buildout::
-
-       cd mediagoblin
-       python bootstrap.py && ./bin/buildout
-
-
-That's it!  Using this method, buildout should create a ``user_dev``
-directory, in which certain things will be stored (media, beaker
-session stuff, etc).  You can change this, but for development
-purposes this default should be fine.
-
-
-**Updating for dependency changes**
-
-While hacking on GNU MediaGoblin over time, you'll eventually have to
-update your development environment because the dependencies have
-changed.  To do that, run::
-
-    ./bin/buildout
-
-
-**Updating for code changes**
-
-You don't need to do anything---code changes are automatically
-available.
-
-
-**Deleting your buildout**
-
-At some point, you may want to delete your buildout.  Perhaps it's to
-start over.  Perhaps it's to test building development environments
-with buildout.
-
-To do this, do::
-
-    rm -rf bin develop-eggs eggs mediagoblin.egg-info parts user_dev
-
-
 Running the server
 ==================
 
-If you did virtualenv, run::
-
-    paster serve mediagoblin.ini --reload
-
 If you did buildout, run::
 
     ./bin/paster serve mediagoblin.ini --reload
 
+If you did virtualenv, run::
+
+    paster serve mediagoblin.ini --reload
 
 Running celeryd
 ===============
@@ -227,26 +230,24 @@ You need to do this if you want your media to process and actually
 show up.  It's probably a good idea in development to have the web
 server (above) running in one terminal and celeryd in another window.
 
-If you did virtualenv, run::
-
-    CELERY_CONFIG_MODULE=mediagoblin.celery_setup.from_celery celeryd
-
 If you did buildout, run::
 
     CELERY_CONFIG_MODULE=mediagoblin.celery_setup.from_celery ./bin/celeryd
 
+If you did virtualenv, run::
+
+    CELERY_CONFIG_MODULE=mediagoblin.celery_setup.from_celery celeryd
 
 Running the test suite
 ======================
 
-If you did virtualenv, run::
-
-    nosetests
-
 If you did buildout, run::
 
     ./bin/nosetests
 
+If you did virtualenv, run::
+
+    nosetests
 
 Troubleshooting
 ===============