Minor edits to the documentation

This patch covers some very minor edits to the documentation, and completes
the initial draft of the documentation for this release.

Change-Id: Ia1a2a893f7f157074e184f11860151c629011798

doc/source/installation.rst

@@ -8,22 +8,22 @@ Installation
 
 Turbo-hipster is installed directly into your Python ``site-packages``
 directory, and is then run as a service. It is managed using a configuration
-file, which is in .json format.
+file, which is in json format.
 
 Installing turbo-hipster
 ------------------------
 
-1. Turbo-Hipster can be installed directly to your Python ``site-packages``
-directory::
+1. Turbo-hipster can be installed directly to your Python ``site-packages``
+directory:
 
  $ sudo python setup.py install
 
 2. Copy the configuration file to a convenient location. By default,
-turbo-hipster will look in ``/etc/turbo-hipster/config.json`` ::
+turbo-hipster will look in ``/etc/turbo-hipster/config.json``:
 
  $ cp -R etc/turbo-hipster /etc/
 
-3. The Turbo-Hipster configuration file is in .json format. Open the
+3. The turbo-hipster configuration file is in json format. Open the
 ``config.json`` configuration file in your preferred editor and modify it
 for your environment::
 
@@ -83,7 +83,7 @@ for your environment::
  $ useradd turbo-hipster
 
 5. Create the directories listed in the configuration file, and give the
-``turbo-hipster`` user write access::
+``turbo-hipster`` user write access:
 
  $ mkdir -p /var/log/turbo-hipster/
  $ chown turbo-hipster:turbo-hipster /var/log/turbo-hipster/
@@ -98,7 +98,7 @@ for your environment::
  $ chown turbo-hipster:turbo-hipster /var/cache/pip
 
 6. Open the MySQL log rotation configuration file in your preferred text
-editor, and edit it to ensure it is writable by ``other``::
+editor, and edit it to ensure it is writable by ``other``:
 
  $ vim /etc/logrotate.d/mysql-server
  # edit create 640 to 644.

doc/source/intro.rst

@@ -21,7 +21,7 @@ migration may take an unreasonable amount of time against a large database.
  Happiness. Fuzzy Happiness takes markup in the sqlalchemy models file and
  uses that to decide what values to anonymize, and how to do so. This feature
  is still in development, and until it is complete turbo-hipster will not
- report back to Zuul automatically. See the Release Notes for more detail.
+ report back to Zuul automatically.
 
 Additionally, turbo-hipster has been designed to be extensible, so it is
 possible to write other plugins to expand its capabilities.
@@ -35,19 +35,19 @@ report back with success or failure. Zuul allows you to specify which jobs
 should be run against which projects. You can create a rule in Zuul for it
 to select jobs that require testing against a database. Turbo-hipster will
 then register as being able to complete that type of job. Gearman handles
-the connection between Zuul and Turbo-Hipster, recognizing when a job
+the connection between Zuul and turbo-hipster, recognizing when a job
 matches the rule, and passing it to turbo-hipster for testing. When turbo-
 hipster receives the patchset for the job, it creates a virtual environment
 to test it. The result of the test is sent back to Gearman as a json string,
 which contains links to compiled logfiles.
 
-The simplified workflow for Turbo-Hipster:
+The simplified workflow for turbo-hipster:
 
 1. Registers as a worker against Zuul's Gearman server
 2. Receives jobs from Zuul as they arrive
 3. Checks out the patchset
 4. Sets up a new virtual environment for testing
-5. Loads in a representative subset of the available datasets
+5. Loads a representative subset of the available datasets
 6. Runs the migration against each dataset, and checks the result
 7. Reports the results to Zuul, using the Gearman protocol
 

doc/source/running.rst

@@ -9,7 +9,7 @@ Starting turbo-hipster
 
 Turbo-hipster can be run from the command line::
 
- $ ./turbo-hipster/worker_server.py
+ $ turbo-hipster
 
 This option allows you to pass parameters to turbo-hipster. Use the --help
 parameter to see a full list.
@@ -45,7 +45,7 @@ Plugins can be used to extend turbo-hipster's capabilities.
 
 .. note::
  Currently, the only available plugin for turbo-hipster is the
- Database Migration plugin, ``gate_real_db_upgrade``, which tests code
+ database migration plugin, ``gate_real_db_upgrade``, which tests code
  against a variety of real-world databases.
 
 Installing plugins
@@ -96,7 +96,7 @@ Testing with turbo-hipster
 ==========================
 
 When turbo-hipster completes a test, it sends the result of the test back to
-Gearman. These results contain a link to a compiled logfile for the test.
+Gearman. These results contain a link to a compiled log file for the test.
 
 If the test fails, or takes too long to complete, turbo-hipster will add a
 review to your patchset that looks like this: