Start replacing default readmes with brief explanations.

diff --git a/cookbooks/accounts/README.md b/cookbooks/accounts/README.md
index 205739199955017d846700bb599100dae9f89479..5ee1cab7807f74f3b81840cfe3c3192f6fc97835 100644 (file)
--- a/cookbooks/accounts/README.md
+++ b/cookbooks/accounts/README.md
@@ -1,34 +1,6 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# Accounts Cookbook
 
-e.g.
-This cookbook makes your favorite breakfast sandwich.
+This cookbook manages the accounts that are present on each machine.
 
-Requirements
-------------
-TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.
-
-Attributes
-----------
-TODO: List you cookbook attributes here.
-
-Usage
------
-TODO: Write usage instructions for each cookbook.
-
-Contributing
-------------
-TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.
-
-e.g.
-1. Fork the repository on Github
-2. Create a named feature branch (like `add_component_x`)
-3. Write your change
-4. Write tests for your change (if applicable)
-5. Run the tests, ensuring they all pass
-6. Submit a Pull Request using Github
-
-License and Authors
--------------------
-Authors: TODO: List authors
+Accounts can be controlled using role attributes, and so particular people can
+be given access to particular groups of machines.

diff --git a/cookbooks/apache/README.md b/cookbooks/apache/README.md
index 205739199955017d846700bb599100dae9f89479..3dab8f9523f9e3de75fc471d4dbfb4d929a8e64b 100644 (file)
--- a/cookbooks/apache/README.md
+++ b/cookbooks/apache/README.md
@@ -1,34 +1,3 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# Apache Cookbook
 
-e.g.
-This cookbook makes your favorite breakfast sandwich.
-
-Requirements
-------------
-TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.
-
-Attributes
-----------
-TODO: List you cookbook attributes here.
-
-Usage
------
-TODO: Write usage instructions for each cookbook.
-
-Contributing
-------------
-TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.
-
-e.g.
-1. Fork the repository on Github
-2. Create a named feature branch (like `add_component_x`)
-3. Write your change
-4. Write tests for your change (if applicable)
-5. Run the tests, ensuring they all pass
-6. Submit a Pull Request using Github
-
-License and Authors
--------------------
-Authors: TODO: List authors
+Installs and configures the Apache webserver.

diff --git a/cookbooks/apt/README.md b/cookbooks/apt/README.md
index 205739199955017d846700bb599100dae9f89479..132a00a053ed64008d13ea3346b24731a894ea9d 100644 (file)
--- a/cookbooks/apt/README.md
+++ b/cookbooks/apt/README.md
@@ -1,34 +1,4 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# Apt Cookbook
 
-e.g.
-This cookbook makes your favorite breakfast sandwich.
-
-Requirements
-------------
-TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.
-
-Attributes
-----------
-TODO: List you cookbook attributes here.
-
-Usage
------
-TODO: Write usage instructions for each cookbook.
-
-Contributing
-------------
-TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.
-
-e.g.
-1. Fork the repository on Github
-2. Create a named feature branch (like `add_component_x`)
-3. Write your change
-4. Write tests for your change (if applicable)
-5. Run the tests, ensuring they all pass
-6. Submit a Pull Request using Github
-
-License and Authors
--------------------
-Authors: TODO: List authors
+Installs and configures the `apt` package manager. This cookbook includes setting
+up various PPAs using an `apt_source` LWRP.

diff --git a/cookbooks/backup/README.md b/cookbooks/backup/README.md
index 205739199955017d846700bb599100dae9f89479..1636aea0acd3206f1e3770fbdf5076dc2fcf705d 100644 (file)
--- a/cookbooks/backup/README.md
+++ b/cookbooks/backup/README.md
@@ -1,34 +1,5 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# Backup Cookbook
 
-e.g.
-This cookbook makes your favorite breakfast sandwich.
-
-Requirements
-------------
-TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.
-
-Attributes
-----------
-TODO: List you cookbook attributes here.
-
-Usage
------
-TODO: Write usage instructions for each cookbook.
-
-Contributing
-------------
-TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.
-
-e.g.
-1. Fork the repository on Github
-2. Create a named feature branch (like `add_component_x`)
-3. Write your change
-4. Write tests for your change (if applicable)
-5. Run the tests, ensuring they all pass
-6. Submit a Pull Request using Github
-
-License and Authors
--------------------
-Authors: TODO: List authors
+This cookbook is run on the machine that stores the central backups. It creates
+the store for the backups and manages their expiry. It also configures the rsync
+daemon used by machines that send in their backups.

diff --git a/cookbooks/bind/README.md b/cookbooks/bind/README.md
index 205739199955017d846700bb599100dae9f89479..087f7782f8a9a49c5f819ffe737947a19c4c3f80 100644 (file)
--- a/cookbooks/bind/README.md
+++ b/cookbooks/bind/README.md
@@ -1,34 +1,4 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# Bind Cookbook
 
-e.g.
-This cookbook makes your favorite breakfast sandwich.
-
-Requirements
-------------
-TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.
-
-Attributes
-----------
-TODO: List you cookbook attributes here.
-
-Usage
------
-TODO: Write usage instructions for each cookbook.
-
-Contributing
-------------
-TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.
-
-e.g.
-1. Fork the repository on Github
-2. Create a named feature branch (like `add_component_x`)
-3. Write your change
-4. Write tests for your change (if applicable)
-5. Run the tests, ensuring they all pass
-6. Submit a Pull Request using Github
-
-License and Authors
--------------------
-Authors: TODO: List authors
+This cookbook installs and configures the BIND DNS system, for use on our
+internal network.

diff --git a/cookbooks/blog/README.md b/cookbooks/blog/README.md
index 205739199955017d846700bb599100dae9f89479..664e47718b83e723e6a09bd710c60fc968765f22 100644 (file)
--- a/cookbooks/blog/README.md
+++ b/cookbooks/blog/README.md
@@ -1,34 +1,3 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# Blog Cookbook
 
-e.g.
-This cookbook makes your favorite breakfast sandwich.
-
-Requirements
-------------
-TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.
-
-Attributes
-----------
-TODO: List you cookbook attributes here.
-
-Usage
------
-TODO: Write usage instructions for each cookbook.
-
-Contributing
-------------
-TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.
-
-e.g.
-1. Fork the repository on Github
-2. Create a named feature branch (like `add_component_x`)
-3. Write your change
-4. Write tests for your change (if applicable)
-5. Run the tests, ensuring they all pass
-6. Submit a Pull Request using Github
-
-License and Authors
--------------------
-Authors: TODO: List authors
+This cookbook manages the wordpress site used for blog.openstreetmap.org

diff --git a/cookbooks/cgiirc/README.md b/cookbooks/cgiirc/README.md
index 205739199955017d846700bb599100dae9f89479..49eeb3d549a2834a994e33b4f6925dd6cb50af00 100644 (file)
--- a/cookbooks/cgiirc/README.md
+++ b/cookbooks/cgiirc/README.md
@@ -1,34 +1,4 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# Cgiirc Cookbook
 
-e.g.
-This cookbook makes your favorite breakfast sandwich.
-
-Requirements
-------------
-TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.
-
-Attributes
-----------
-TODO: List you cookbook attributes here.
-
-Usage
------
-TODO: Write usage instructions for each cookbook.
-
-Contributing
-------------
-TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.
-
-e.g.
-1. Fork the repository on Github
-2. Create a named feature branch (like `add_component_x`)
-3. Write your change
-4. Write tests for your change (if applicable)
-5. Run the tests, ensuring they all pass
-6. Submit a Pull Request using Github
-
-License and Authors
--------------------
-Authors: TODO: List authors
+This cookbook installs and configures the `cgiirc` program that powers the
+web interface to the OSM IRC channels, found at irc.openstreetmap.org

diff --git a/cookbooks/chef/README.md b/cookbooks/chef/README.md
index 205739199955017d846700bb599100dae9f89479..0f810498eb39c0349cbaad531850e7f95497cc0c 100644 (file)
--- a/cookbooks/chef/README.md
+++ b/cookbooks/chef/README.md
@@ -1,34 +1,9 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# Chef Cookbook
 
-e.g.
-This cookbook makes your favorite breakfast sandwich.
+This cookbook controls the versions of Chef installed on our machines. There are
+four recipes available:
 
-Requirements
-------------
-TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.
-
-Attributes
-----------
-TODO: List you cookbook attributes here.
-
-Usage
------
-TODO: Write usage instructions for each cookbook.
-
-Contributing
-------------
-TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.
-
-e.g.
-1. Fork the repository on Github
-2. Create a named feature branch (like `add_component_x`)
-3. Write your change
-4. Write tests for your change (if applicable)
-5. Run the tests, ensuring they all pass
-6. Submit a Pull Request using Github
-
-License and Authors
--------------------
-Authors: TODO: List authors
+* default: Installs the chef-client
+* gems: Allows cookbooks to use specific gems during chef runs
+* repository: ?
+* server: Installs the chef server

diff --git a/cookbooks/civicrm/README.md b/cookbooks/civicrm/README.md
index 205739199955017d846700bb599100dae9f89479..244648c49c5d32627f453f5694ef48e46df86b18 100644 (file)
--- a/cookbooks/civicrm/README.md
+++ b/cookbooks/civicrm/README.md
@@ -1,34 +1,4 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# CiviCRM Cookbook
 
-e.g.
-This cookbook makes your favorite breakfast sandwich.
-
-Requirements
-------------
-TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.
-
-Attributes
-----------
-TODO: List you cookbook attributes here.
-
-Usage
------
-TODO: Write usage instructions for each cookbook.
-
-Contributing
-------------
-TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.
-
-e.g.
-1. Fork the repository on Github
-2. Create a named feature branch (like `add_component_x`)
-3. Write your change
-4. Write tests for your change (if applicable)
-5. Run the tests, ensuring they all pass
-6. Submit a Pull Request using Github
-
-License and Authors
--------------------
-Authors: TODO: List authors
+This cookbook installs  CiviCRM for Wordpress, and configures it for use with
+join.osmfoundation.org for OSMF memberships.