doc: Make some minor changes to the new documentation

Signed-off-by: Sol Jerome <sol.jerome@gmail.com>

8 files changed, 80 insertions, 82 deletions

diff --git a/doc/appendix/articles.txt b/doc/appendix/articles.txt
index 4e31dd7ed..4a842a00e 100644
--- a/doc/appendix/articles.txt
+++ b/doc/appendix/articles.txt
@@ -21,5 +21,4 @@ Articles
 * `System Management Methodologies with Bcfg2 <ftp://ftp.mcs.anl.gov/pub/bcfg/papers/login-reports.pdf>`_
 
  * Narayan Desai, Rick Bradshaw and Joey Hagedorn
- * In ;login: Magazine, Volume 31, #1, pages 11-18, February 2006 
-
+ * In ;login: Magazine, Volume 31, #1, pages 11-18, February 2006
diff --git a/doc/appendix/books.txt b/doc/appendix/books.txt
index 7cb864810..43906bca4 100644
--- a/doc/appendix/books.txt
+++ b/doc/appendix/books.txt
@@ -8,5 +8,4 @@ Books
 
 * `Configuration Management with Bcfg2 <http://www.sage.org/pubs/19_bcfg2/>`_
 
- * Narayan Desai and Cory Lueninghoener 
-
+ * Narayan Desai and Cory Lueninghoener
diff --git a/doc/appendix/contributors.txt b/doc/appendix/contributors.txt
index 88246b513..9f2c18115 100644
--- a/doc/appendix/contributors.txt
+++ b/doc/appendix/contributors.txt
@@ -9,7 +9,7 @@
 Contributors
 ============
 
-.. 
+..
    This is list is no longer in chronological order like the
    AUTHORS file because it's easier to maintain (for me).
    Automatically sorted.
@@ -22,7 +22,7 @@ In alphabetical order of the given name:
 - Daniel Clark <dclark@pobox.com> created encap packages for bcfg2 and deps, wrote fossil-scm dvcs support, and helps with Debian packaging
 - Danny Clark enabled the Encap packaging
 - David Dahl worked on Hostbase
-- David Strauss worked on CentOS, RHEL, Yum, and Bazaar VCS support 
+- David Strauss worked on CentOS, RHEL, Yum, and Bazaar VCS support
 - Ed Smith <esmith4@inf.ed.ac.uk> has done substantial hardening of the bcfg client and server and implemented a common logging infrastructure.
 - Fabian Affolter <fabian@bernewireless.net> made some patches and worked on the manual
 - Jason Pepas <cell@ices.utexas.edu> has written a RPM package list creator has contributed patches to the Red Hat toolset
@@ -37,7 +37,8 @@ In alphabetical order of the given name:
 - Sami Haahtinen <ressu@ressukka.net> has written Debian packaging logic.
 - Scott Behrens <behrens@mcs.anl.gov> and Rick Bradshaw have written the VHost plugin
 - Scott Matott
-- Sol Jerome <solj@ices.utexas.edu> squashes bugs, helps manage the project roadmap, and implements various interesting features.
+- Sol Jerome <sol.jerome@gmail.com> squashes bugs, helps manage the
+  project roadmap, and implements various interesting features.
 - Ti Leggett worked on ebuild packaging and bugfixes, RPM packaging
 - Zach Lowry Solaris support and general hardening
 
@@ -49,5 +50,4 @@ throughout this project. Philip Steinbachs provided detailed
 feedback as an early external user.
 
 The most updated listing is available in the AUTHORS_ file in the
-SVN :term:`repository` of Bcfg2.
-
+git :term:`repository` for Bcfg2.
diff --git a/doc/appendix/files.txt b/doc/appendix/files.txt
index e5217b684..c96393065 100644
--- a/doc/appendix/files.txt
+++ b/doc/appendix/files.txt
@@ -7,7 +7,7 @@ Example files
 =============
 
 In this section are some examples for getting started with a more 
-indeep usage of Bcfg2.
+in-depth usage of Bcfg2.
 
 .. toctree::
    :maxdepth: 1
diff --git a/doc/appendix/files/mysql.txt b/doc/appendix/files/mysql.txt
index ae4a1450b..81104ec17 100644
--- a/doc/appendix/files/mysql.txt
+++ b/doc/appendix/files/mysql.txt
@@ -1,10 +1,10 @@
 .. -*- mode: rst -*-
 
-.. _getting_started-mysql:
+.. _appendix-files-mysql:
 
 .. Author: Patrick Ruckstuhl
 
-Mysql example
+MySQL example
 =============
 
 I had some time ago to continue with putting my configuration into 
@@ -15,8 +15,8 @@ I added a new bundle:
 .. code-block:: xml
 
     <Bundle name="mysql-server" version="3.0">
-       <ConfigFile name="/root/bcfg2-install/mysql/users.sh"/>
-       <ConfigFile name="/root/bcfg2-install/mysql/users.sql"/>
+       <Path name="/root/bcfg2-install/mysql/users.sh"/>
+       <Path name="/root/bcfg2-install/mysql/users.sql"/>
        <PostInstall name="/root/bcfg2-install/mysql/users.sh"/>
        <Package name="mysql-server-4.1"/>
        <Service name="mysql"/>
@@ -34,18 +34,14 @@ The ``users.sh`` script looks like this:
 On debian there is a user account in ``/etc/mysql/debian.cnf`` 
 automatically created, but you could also (manually) create a 
 user in the database that has enough permissions and add the 
-login information in a file yourself. This file looks like this:
-
-.. code-block:: sh
+login information in a file yourself. This file looks like this::
 
     [client]
     host     = localhost
     user     = debian-sys-maint
     password = XXXXXXXXXX
 
-The ``users.sql`` looks like this:
-
-.. code-block:: sh
+The ``users.sql`` looks like this::
 
     DELETE FROM db;
     INSERT INTO db VALUES ('localhost', 'phpmyadmin', 'pma', 'Y', 'Y',
@@ -60,4 +56,3 @@ The ``users.sql`` looks like this:
     'N', 'N', 'N', '', '', '', '', 0, 0, 0);
 
     FLUSH PRIVILEGES;
-
diff --git a/doc/appendix/files/ntp.txt b/doc/appendix/files/ntp.txt
index 33cb3bfbb..ec1fa3094 100644
--- a/doc/appendix/files/ntp.txt
+++ b/doc/appendix/files/ntp.txt
@@ -21,76 +21,81 @@ Package only
 Our example starts with the bare minimum configuration setup. We have
 a client, a profile group, a list of packages, and a base configuration.
 
-.. code-block:: sh
+``Metadata/clients.xml``:
 
-     # cat Metadata/clients.xml 
-     <Clients version='3.0'>
-     <Client profile='fedora' pingable='N' pingtime='0' name='foo.bar.com'/>
-     </Clients>
+.. code-block:: xml
 
-.. code-block:: sh
+    <Clients version='3.0'>
+    <Client profile='fedora' pingable='N' pingtime='0' name='foo.bar.com'/>
+    </Clients>
 
-     # cat Metadata/groups.xml 
-     <Groups version='3.0'>
-     <Group profile='true' name='fedora' toolset='rh'/>
-     </Groups>
+``Metadata/groups.xml``:
 
-.. code-block:: sh
+.. code-block:: xml
 
-     # cat Base/base.xml 
-     <Base>
-     <Group name='fedora'>
-     <Package name='ntp'/>
-     </Group>
-     </Base>
+    <Groups version='3.0'>
+    <Group profile='true' name='fedora' toolset='rh'/>
+    </Groups>
+
+``Base/base.xml``:
 
-.. code-block:: sh
+.. code-block:: xml
 
-     # cat Pkgmgr/packages.xml
-     <PackageList type='rpm' priority='0'>
-     <Package name='ntp' version='4.2.0.a.20050816-11.FC5'/>
-     </PackageList>
+    <Base>
+    <Group name='fedora'>
+    <Package name='ntp'/>
+    </Group>
+    </Base>
+
+``Pkgmgr/packages.xml``:
+
+.. code-block:: xml
+
+    <PackageList type='rpm' priority='0'>
+    <Package name='ntp' version='4.2.0.a.20050816-11.FC5'/>
+    </PackageList>
 
 Add service
 -----------
 
 Configure the service, and add it to the base.
 
-.. code-block:: sh
+``Svcmgr/services.xml``:
 
-     # cat Svcmgr/services.xml 
-     <Services priority='0'>
-     <Service name='ntpd' status='on'/>
-     </Services>
+.. code-block:: xml
 
-.. code-block:: sh
+    <Services priority='0'>
+    <Service name='ntpd' status='on'/>
+    </Services>
 
-     # cat Base/base.xml 
-     <Base>
-     <Group name='fedora'>
-     <Package name='ntp'/>
-     <Service name='ntpd'/>
-     </Group>
-     </Base>
+``Base/base.xml``:
+
+.. code-block:: xml
+
+    <Base>
+    <Group name='fedora'>
+    <Package name='ntp'/>
+    <Service name='ntpd'/>
+    </Group>
+    </Base>
 
 Add config file
 ---------------
 
-Setup an ``etc/`` directory structure, and add it to the base.
-
-.. code-block:: sh
+Setup an ``etc/`` directory structure, and add it to the base.::
 
      # cat Cfg/etc/ntp.conf/ntp.conf 
      server ntp1.utexas.edu
 
-.. code-block:: sh
+``Base/base.xml``:
 
-     # cat Base/base.xml 
-     <Base>
+.. code-block:: xml
+
+    <Base>
      <Group name='fedora'>
      <Package name='ntp'/>
      <Service name='ntpd'/>
-     <ConfigFile name='/etc/ntp.conf'/>
+     <Path name='/etc/ntp.conf'/>
      </Group>
     </Base>
 
@@ -105,7 +110,7 @@ related configuration entries that are used to provide a single
 service. This is done for several reasons:
 
 * Grouping related things in one place makes it easier to add those
-  entries for a multiple groups of clients
+  entries for multiple groups of clients
 * Grouping entries into bundles makes their validation occur
   collectively. This means that config files can override the
   contents of packages. Also, config files are rechecked after
@@ -119,22 +124,24 @@ The config file, package, and service are really all related
 components describing the idea of an ntp client, so they should be 
 logically grouped together. We use a bundle to accomplish this.
 
-.. code-block:: sh
+``Bundler/ntp.xml``:
 
-     # cat Bundler/ntp.xml
-     <Bundle name='ntp' version='2.0'>
-     <Package name='ntp'/>
-     <Service name='ntpd'/>
-     <ConfigFile name='/etc/ntp.conf'/>
-     </Bundle>
+.. code-block:: xml
+
+    <Bundle name='ntp' version='2.0'>
+    <Package name='ntp'/>
+    <Service name='ntpd'/>
+    <Path name='/etc/ntp.conf'/>
+    </Bundle>
 
 After this bundle is created, it must be associated with a group
 (or groups). Add a bundle child element to the group(s) which should
 install this bundle.
 
-.. code-block:: sh
+``Metadata/groups.xml``:
+
+.. code-block:: xml
 
-     # cat Metadata/groups.xml
      <Groups>
     ...
      <Group name='fedora'>
@@ -143,9 +150,8 @@ install this bundle.
     ...
      </Groups>
 
-Once this bundle is created, a client reconfigure will install these 
-entries. If any are modified, then the ``ntpd`` service will be
-restarted. If you only want ntp configurations to be updated
-(and nothing else), the bcfg2 client can be run with a 
-``-b <bundle name>`` option that will only update entries in
-the specified bundle.
+Once this bundle is created, a client reconfigure will install
+these entries. If any are modified, then the *ntpd* service will
+be restarted. If you only want ntp configurations to be updated (and
+nothing else), the bcfg2 client can be run with a ``-b <bundle name>``
+option that will only update entries in the specified bundle.
diff --git a/doc/appendix/guides/authentication.txt b/doc/appendix/guides/authentication.txt
index b9efbb929..13b797625 100644
--- a/doc/appendix/guides/authentication.txt
+++ b/doc/appendix/guides/authentication.txt
@@ -123,7 +123,7 @@ or password only. Also a bootstrap mode will be added shortly; this
 will allow a client to authenticate with a password its first time,
 requiring a certificate all subsequent times. This behavior can be
 controlled through the use of the auth attribute in
-`Metadata/clients.xml`::
+``Metadata/clients.xml``::
 
     <Clients>
       <Client name='testclient' auth='cert'/>
diff --git a/doc/unsorted/writing_specification.txt b/doc/unsorted/writing_specification.txt
index eced54841..5a75165bf 100644
--- a/doc/unsorted/writing_specification.txt
+++ b/doc/unsorted/writing_specification.txt
@@ -166,8 +166,7 @@ The following is an annotated copy of a bundle:
 
 .. code-block:: xml
 
-    <Bundle revision='$Revision: 2668 $' name='ssh' version='2.0'
-            origin='https://svn.mcs.anl.gov/repos/bcfg/trunk/repository/Bundler/ssh.xml'>
+    <Bundle name='ssh' version='2.0'>
       <Path name='/etc/ssh/ssh_host_dsa_key'/>
       <Path name='/etc/ssh/ssh_host_rsa_key'/>
       <Path name='/etc/ssh/ssh_host_dsa_key.pub'/>