Refactored the README with individual sections for each state

README.rst

@@ -1,7 +1,8 @@
+======
 apache
 ======
 
-Formulas to set up and configure the Apache HTTP server
+Formulas to set up and configure the Apache HTTP server.
 
 .. note::
 
@@ -9,34 +10,104 @@ Formulas to set up and configure the Apache HTTP server
     <http://docs.saltstack.com/topics/conventions/formulas.html>`_.
 
 Available states
-----------------
+================
+
+.. contents::
+    :local:
 
 ``apache``
-    Installs the Apache package and starts the service.
+----------
+
+Installs the Apache package and starts the service.
+
 ``apache.mod_wsgi``
-    Installs the mod_wsgi package and enables the Apache module.
+-------------------
+
+Installs the mod_wsgi package and enables the Apache module.
+
+``apache.vhost.standard``
+-------------------------
+
+Configures Apache name-based virtual hosts using data from Pillar.
+
+Example Pillar:
+
+.. code:: yaml
+
+    apache:
+      sites:
+        # Default values below are used unless disabled by setting to 'None'.
+        example.com: # must be unique; used as an ID declaration in Salt; also passed to the template context as {{ id }}
+          template_file: salt://apache/vhosts/standard.tmpl
+          template_engine: jinja
+
+          interface: '*'
+          port: '80'
+
+          ServerName: {{ id }} # uses the unique ID above unless specified
+          ServerAlias: www.{{ id }}
+
+          ServerAdmin: webmaster@{{ id }}
+
+          LogLevel: warn
+          ErrorLog: {{ logdir }}/{{ id }}-error.log # E.g.: /var/log/apache2/example.com-error.log
+          CustomLog: {{ logdir }}/{{ id }}-access.log # E.g.: /var/log/apache2/example.com-access.log
+
+          DocumentRoot: {{ wwwdir }}/{{ id }} # E.g., /var/www/example.com
+
+          Directory:
+            {{ wwwdir }}/{{ id }}: # E.g.: /var/www/example.com:
+              Options: -Indexes FollowSymLinks
+              Order: allow,deny
+              Allow: from all
+              AllowOverride: All
+              Formula_Append: |
+                Additional config as a
+                multi-line string here
+
+          Formula_Append: |
+            Additional config as a
+            multi-line string here
+
+        example.net:
+          template_file: salt://apache/vhosts/minimal.tmpl
+
+
 ``apache.debian_full``
-    Installs and configures Apache on Debian and Ubuntu systems.
+----------------------
+
+Installs and configures Apache on Debian and Ubuntu systems.
+
+These states are ordered using the ``order`` declaration. Different stages
+are divided into the following number ranges:
+
+1)  apache will use 1-500 for ordering
+2)  apache will reserve 1  -100 as unused
+3)  apache will reserve 101-150 for pre pkg install
+4)  apache will reserve 151-200 for pkg install
+5)  apache will reserve 201-250 for pkg configure
+6)  apache will reserve 251-300 for downloads, git stuff, load data
+7)  apache will reserve 301-400 for unknown purposes
+8)  apache will reserve 401-450 for service restart-reloads
+9)  apache WILL reserve 451-460 for service.running
+10) apache will reserve 461-500 for cmd requiring operational services
 
-    These states are ordered using the ``order`` declaration. Different stages
-    are divided into the following number ranges:
+Dependencies:
 
-    1)  apache will use 1-500 for ordering
-    2)  apache will reserve 1  -100 as unused
-    3)  apache will reserve 101-150 for pre pkg install
-    4)  apache will reserve 151-200 for pkg install
-    5)  apache will reserve 201-250 for pkg configure
-    6)  apache will reserve 251-300 for downloads, git stuff, load data
-    7)  apache will reserve 301-400 for unknown purposes
-    8)  apache will reserve 401-450 for service restart-reloads
-    9)  apache WILL reserve 451-460 for service.running
-    10) apache will reserve 461-500 for cmd requiring operational services
+* `apt <https://github.com/saltstack-formulas/apt-formula>`_
 
-    Dependencies:
+Optional dependencies:
 
-    * `apt <https://github.com/saltstack-formulas/apt-formula>`_
+1) `php <https://github.com/saltstack-formulas/php-formula>`_
 
-    Optional dependencies:
+Example Pillar:
 
-    1) `php <https://github.com/saltstack-formulas/php-formula>`_
+.. code:: yaml
 
+    apache:
+      register-site:
+        # any name as an array index, and you can duplicate this section
+        {{UNQIUE}}:
+          name: 'my name'
+          path: 'salt://path/to/sites-available/conf/file'
+          state: 'enabled'