From: Andy Allan Date: Wed, 6 Jan 2016 16:33:52 +0000 (+0000) Subject: Add more READMEs. X-Git-Url: https://git.openstreetmap.org/chef.git/commitdiff_plain/62c8abda084e509811837655ba68e99b80dfe56f Add more READMEs. --- diff --git a/cookbooks/git/README.md b/cookbooks/git/README.md index 205739199..588b4f329 100644 --- a/cookbooks/git/README.md +++ b/cookbooks/git/README.md @@ -1,34 +1,7 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# git Cookbook -e.g. -This cookbook makes your favorite breakfast sandwich. +This cookbook contains three recipes relating to git: -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 git +* server: configures the machine to act as a git server +* web: configures the git-web interface used a http://git.openstreetmap.org diff --git a/cookbooks/gps-tile/README.md b/cookbooks/gps-tile/README.md index 205739199..f6394d5a1 100644 --- a/cookbooks/gps-tile/README.md +++ b/cookbooks/gps-tile/README.md @@ -1,34 +1,5 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# gps-tile 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 gps-tile service found at +http://gps-tile.openstreetmap.org which produces map images from the combined +osm gpx traces database diff --git a/cookbooks/hardware/README.md b/cookbooks/hardware/README.md index 205739199..0eb3acf1e 100644 --- a/cookbooks/hardware/README.md +++ b/cookbooks/hardware/README.md @@ -1,34 +1,6 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Hardware 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 contains a lot of different things relating to hardware, disks +and RAID controller configurations. It also contains an ohai plugin that helps +gather detailed hardware information from the machines beyond what you normally +get from ohai. diff --git a/cookbooks/imagery/README.md b/cookbooks/imagery/README.md index 205739199..d57898abe 100644 --- a/cookbooks/imagery/README.md +++ b/cookbooks/imagery/README.md @@ -1,34 +1,3 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Imagery 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 installs various packages needed for aerial imagery processing. diff --git a/cookbooks/incron/README.md b/cookbooks/incron/README.md index 205739199..095b00679 100644 --- a/cookbooks/incron/README.md +++ b/cookbooks/incron/README.md @@ -1,34 +1,3 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# incron 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 incron, an inotify-based cron. diff --git a/cookbooks/kibana/README.md b/cookbooks/kibana/README.md index 205739199..8f1644f44 100644 --- a/cookbooks/kibana/README.md +++ b/cookbooks/kibana/README.md @@ -1,34 +1,3 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Kibana 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 Kibana, a web-based interface to elasticsearch. diff --git a/cookbooks/logstash/README.md b/cookbooks/logstash/README.md index 205739199..7bcc94a9d 100644 --- a/cookbooks/logstash/README.md +++ b/cookbooks/logstash/README.md @@ -1,34 +1,3 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Logstash 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 Logstash, which takes events and stores them in elasticsearch. diff --git a/cookbooks/mailman/README.md b/cookbooks/mailman/README.md index 205739199..c67d7d644 100644 --- a/cookbooks/mailman/README.md +++ b/cookbooks/mailman/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# mailman 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 mailman, used for mailing lists, along with the web +interface for the list archives. diff --git a/cookbooks/mediawiki/README.md b/cookbooks/mediawiki/README.md index 205739199..6e7f7de25 100644 --- a/cookbooks/mediawiki/README.md +++ b/cookbooks/mediawiki/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Mediawiki 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 the dependencies for mediawiki sites, and has LWRPs for +mediawiki sites, extensions and skins. diff --git a/cookbooks/memcached/README.md b/cookbooks/memcached/README.md index 205739199..1842b2860 100644 --- a/cookbooks/memcached/README.md +++ b/cookbooks/memcached/README.md @@ -1,34 +1,3 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# memcached 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 memcached daemon.