Add more cookbook readmes.
authorAndy Allan <git@gravitystorm.co.uk>
Wed, 20 Jul 2016 10:48:31 +0000 (11:48 +0100)
committerAndy Allan <git@gravitystorm.co.uk>
Wed, 20 Jul 2016 10:48:31 +0000 (11:48 +0100)
14 files changed:
cookbooks/switch2osm/README.md
cookbooks/sysctl/README.md
cookbooks/sysfs/README.md
cookbooks/taginfo/README.md
cookbooks/thinkup/README.md
cookbooks/tile/README.md
cookbooks/tilecache/README.md
cookbooks/tools/README.md
cookbooks/trac/README.md
cookbooks/web/README.md
cookbooks/wiki/README.md
cookbooks/wordpress/README.md
cookbooks/xinetd/README.md
cookbooks/yournavigation/README.md

index 205739199955017d846700bb599100dae9f89479..7275bd44d58fa941b244b35efda73a06e774cb99 100644 (file)
@@ -1,34 +1,4 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# switch2osm 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 wordpress website that powers
+[www.switch2osm.org](http://www.switch2osm.org)
index 205739199955017d846700bb599100dae9f89479..c154b579fda3c76a27f61920b4d8ce5ca36999b5 100644 (file)
@@ -1,34 +1,5 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# sysctl 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 allows various sysctl settings to be controlled via attributes.
+Settings can be added to node[:sysctl] attribute, and these are both updated
+via `/proc/sys` and added to a template in `/etc/sysctl.d/`
index 205739199955017d846700bb599100dae9f89479..f7a221b225145ff25c7c470b9523988577fe047a 100644 (file)
@@ -1,34 +1,4 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# sysfs 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 sysfs, which allows various kernel
+configuration parameters to be tuned via node attributes.
index 205739199955017d846700bb599100dae9f89479..d116c60e0136f1eae9e5457c2bc74a4a0813e307 100644 (file)
@@ -1,34 +1,5 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# taginfo 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 taginfo websites. The OSMF use this
+cookbook to manage a global taginfo instance at
+[taginfo.openstreetmap.org](http://taginfo.openstreetmap.org)
index 205739199955017d846700bb599100dae9f89479..0fc9b1f7add227678eaf16778561bbe6dca3cc0c 100644 (file)
@@ -1,34 +1,5 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# thinkup 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
+[thinkup.openstreetmap.org](http://thinkup.openstreetmap.org) social media
+tracking website.
index 205739199955017d846700bb599100dae9f89479..c439d2fb438b6c1534f6deaf6620662350e64fd3 100644 (file)
@@ -1,34 +1,4 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# 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 mod_tile+renderd based tileservers
+that power tile.openstreetmap.org
index 205739199955017d846700bb599100dae9f89479..49667468608dab21f4351c47dc14270d3ae1aa80 100644 (file)
@@ -1,34 +1,4 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# tilecache 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 tile caches for the
+tile.openstreetmap.org tileservers.
index 205739199955017d846700bb599100dae9f89479..9e7255e023d270d2fdfbae592e5c7a2176c1faf3 100644 (file)
@@ -1,34 +1,4 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# tools 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 a variety of system administration tools, and removes
+a few unnecessary ones.
index 205739199955017d846700bb599100dae9f89479..ccd6f133733edd14c3a67615775fd88fa81ba9bd 100644 (file)
@@ -1,34 +1,4 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# trac 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 trac project management website found
+at [trac.openstreetmap.org](trac.openstreetmap.org).
index 205739199955017d846700bb599100dae9f89479..2d881fc3e5ec0c91f88d46e6447f143f2de0caf2 100644 (file)
@@ -1,34 +1,13 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
-
-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
+# web cookbook
+
+This cookbook installs and configures the web frontend machines that power
+[www.openstreetmap.org](http://www.openstreetmap.org). There are several recipes
+
+* `web::backend` - sets up the backend servers, used for processing longer-running requests
+* `web::base` - sets up common storage configuration between all the machines
+* `web::cgimap` - builds and configures [cgimap](https://github.com/openstreetmap/cgimap)
+* `web::cleanup` - configures a cleanup script to be run daily
+* `web::frontend` - sets up the frontend servers, that handle all inbound requests
+* `web::gpx` - sets up the GPX importer
+* `web::rails` - installs and configures the [openstreetmap-website](https://github.com/openstreetmap/openstreetmap-website) rails app
+* `web::statistics` - sets up the scripts for generating the [statistics page](http://www.openstreetmap.org/stats/data_stats.html) for OSM contributions
index 205739199955017d846700bb599100dae9f89479..faa672347b24ecb8b1dc9ea1198e17bf5158e3d9 100644 (file)
@@ -1,34 +1,4 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# wiki 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 mediawiki instance that powers
+[wiki.openstreetmap.org](https://wiki.openstreetmap.org)
index 205739199955017d846700bb599100dae9f89479..e3ab3250a698169d3a3febc45b257d549002af91 100644 (file)
@@ -1,34 +1,4 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# wordpress 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 recipes, providers and libraries to install and configure
+wordpress. It is used as a base cookbook by other wordpress site-specific cookbooks.
index 205739199955017d846700bb599100dae9f89479..f2dfdc58c1208ada30a498c3cbc9cf63577f395e 100644 (file)
@@ -1,34 +1,5 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# xinetd 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 manages the
+[xinetd](https://en.wikipedia.org/wiki/Xinetd) service, which acts as
+an internet daemon.
index 205739199955017d846700bb599100dae9f89479..e5755e67168b500f12ce8a4e0a09c9a1e92d2911 100644 (file)
@@ -1,34 +1,6 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# yournavigation cookbook
 
-e.g.
-This cookbook makes your favorite breakfast sandwich.
+This cookbook builds and environment suitable for running gosmore as part of the
+[YOURS](http://wiki.openstreetmap.org/wiki/YOURS) routing service.
 
-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
+Note that the installation and configuration of gosmore itself is not covered by the cookbook.