From: Tom Hughes Date: Wed, 13 Jan 2016 18:16:28 +0000 (+0000) Subject: Merge remote-tracking branch 'github/pull/49' X-Git-Url: https://git.openstreetmap.org/chef.git/commitdiff_plain/79e281814b6b7e100cc1bf6e1cfacb47ccc28155?hp=0ef6aafef4b54ce79fe84eb44ff058f37e807d74 Merge remote-tracking branch 'github/pull/49' --- diff --git a/cookbooks/munin/README.md b/cookbooks/munin/README.md index 205739199..05ae2cd8e 100644 --- a/cookbooks/munin/README.md +++ b/cookbooks/munin/README.md @@ -1,34 +1,11 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Munin Cookbook -e.g. -This cookbook makes your favorite breakfast sandwich. +This cookbook configures munin, which we use for server monitoring at +[munin.openstreetmap.org](http://munin.openstreetmap.org). The cookbook +contains two recipes: -Requirements ------------- -TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc. +* default - installs and configures munin-node on each machine. +* server - configures the central munin server -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 +Additionally two providers are defined - munin_plugin and munin_plugin_conf, for +configuring individual munin plugins. diff --git a/cookbooks/mysql/README.md b/cookbooks/mysql/README.md index 205739199..0ea9525b0 100644 --- a/cookbooks/mysql/README.md +++ b/cookbooks/mysql/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# MySQL 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 MySQL database software. It also +defines two providers, for configuring MySQL users and databases. diff --git a/cookbooks/networking/README.md b/cookbooks/networking/README.md index 205739199..84a58a6fa 100644 --- a/cookbooks/networking/README.md +++ b/cookbooks/networking/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Networking 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 configures various aspects of networking, including firewall +rules. diff --git a/cookbooks/nfs/README.md b/cookbooks/nfs/README.md index 205739199..da1c028bb 100644 --- a/cookbooks/nfs/README.md +++ b/cookbooks/nfs/README.md @@ -1,34 +1,7 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# NFS Cookbook -e.g. -This cookbook makes your favorite breakfast sandwich. +This cookbook configures NFS (the Network File System) which is used on +various servers. There are two recipes: -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: configures NFS clients based on node attributes. +* server: configures the central NFS server. diff --git a/cookbooks/nginx/README.md b/cookbooks/nginx/README.md index 205739199..2dff4f532 100644 --- a/cookbooks/nginx/README.md +++ b/cookbooks/nginx/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Nginx 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 nginx webserver. Additionally it +defines an `nginx_site` provider for configuring individual websites. diff --git a/cookbooks/nodejs/README.md b/cookbooks/nodejs/README.md index 205739199..55f8d01d9 100644 --- a/cookbooks/nodejs/README.md +++ b/cookbooks/nodejs/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Node.js 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 Node.js runtime, and defines a `nodejs_package` +provider to install packages using npm. diff --git a/cookbooks/nominatim/README.md b/cookbooks/nominatim/README.md index 205739199..28c0ff364 100644 --- a/cookbooks/nominatim/README.md +++ b/cookbooks/nominatim/README.md @@ -1,34 +1,9 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Nominatim Cookbook -e.g. -This cookbook makes your favorite breakfast sandwich. +This cookbook installs and configures the Nominatim geocoding 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 +It contains four recipes: +* base: common functionality for other recipes +* standalone: run nominatim on a standalone server +* master: run a master node in a replicated setup +* slave: run a slave node in replicated setup diff --git a/cookbooks/ntp/README.md b/cookbooks/ntp/README.md index 205739199..f4a94741c 100644 --- a/cookbooks/ntp/README.md +++ b/cookbooks/ntp/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# NTP 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 NTP (Network Time Protocol) service, +which ensures the accuracy of the server clock time. diff --git a/cookbooks/ohai/README.md b/cookbooks/ohai/README.md index 205739199..8aed12fba 100644 --- a/cookbooks/ohai/README.md +++ b/cookbooks/ohai/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Ohai 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 an `ohai_plugin` provider, which can be used to install +custom Ohai plugins for extended hardware detection during chef runs. diff --git a/cookbooks/openssh/README.md b/cookbooks/openssh/README.md index 205739199..75929f5d6 100644 --- a/cookbooks/openssh/README.md +++ b/cookbooks/openssh/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# OpenSSH 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 OpenSSH clients and servers on each +machine. diff --git a/cookbooks/openvpn/README.md b/cookbooks/openvpn/README.md index 205739199..4936476c5 100644 --- a/cookbooks/openvpn/README.md +++ b/cookbooks/openvpn/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# OpenVPN -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 OpenVPN used for secure network +connections between our datacentres. diff --git a/cookbooks/osmosis/README.md b/cookbooks/osmosis/README.md index 205739199..eb1b9b97f 100644 --- a/cookbooks/osmosis/README.md +++ b/cookbooks/osmosis/README.md @@ -1,34 +1,3 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Osmosis 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 Osmosis, the OSM data processing tool. diff --git a/cookbooks/osqa/README.md b/cookbooks/osqa/README.md index 205739199..04a39fc39 100644 --- a/cookbooks/osqa/README.md +++ b/cookbooks/osqa/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# OSQA 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 instances of OSQA, the system that powers +[help.openstreetmap.org](http://help.openstreetmap.org). diff --git a/cookbooks/otrs/README.md b/cookbooks/otrs/README.md index 205739199..836822982 100644 --- a/cookbooks/otrs/README.md +++ b/cookbooks/otrs/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# OTRS 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 instances of OTRS +(Open-source Ticket Request System), used by the Data Working Group. diff --git a/cookbooks/owl/README.md b/cookbooks/owl/README.md index 205739199..7072e2224 100644 --- a/cookbooks/owl/README.md +++ b/cookbooks/owl/README.md @@ -1,34 +1,3 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# OWL 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 OpenStreetMap Watch List service. diff --git a/cookbooks/passenger/README.md b/cookbooks/passenger/README.md index 205739199..02cc6ea43 100644 --- a/cookbooks/passenger/README.md +++ b/cookbooks/passenger/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Passenger 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 Passenger apache module used for +running rails applications. diff --git a/cookbooks/piwik/README.md b/cookbooks/piwik/README.md index 205739199..a968336a3 100644 --- a/cookbooks/piwik/README.md +++ b/cookbooks/piwik/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Piwik 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 Piwiki server-side software used for +analytics on openstreetmap.org diff --git a/cookbooks/planet/README.md b/cookbooks/planet/README.md index 205739199..926c20755 100644 --- a/cookbooks/planet/README.md +++ b/cookbooks/planet/README.md @@ -1,34 +1,11 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Planet Cookbook -e.g. -This cookbook makes your favorite breakfast sandwich. +This cookbook configures the various components of the planet service - used +for distributing OpenStreetMap data at +[planet.openstreetmap.org](http://planet.openstreetmap.org) -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 +It includes the following recipes: +* default: configures the website for serving the various planet files +* dump: installs and configures the planet-dump-ng software to create the dumps +* notes: configures the dump of the OpenStreetMap notes +* replication: configures the minutely, hourly and daily replication diffs diff --git a/cookbooks/postgresql/README.md b/cookbooks/postgresql/README.md index 205739199..7f895005c 100644 --- a/cookbooks/postgresql/README.md +++ b/cookbooks/postgresql/README.md @@ -1,34 +1,11 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# PostgreSQL Cookbook -e.g. -This cookbook makes your favorite breakfast sandwich. +This cookbook installs and configures the PostgreSQL database software. It +defines a number of providers that can be used in other cookbooks: -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 +* database: For managing databases. +* execute: For running commands against the database. +* extension: For installing extensions. +* munin: For configuring munin plugins for a given database name. +* table: For managing database tables. +* user: For managing database users. diff --git a/cookbooks/roundup/README.md b/cookbooks/roundup/README.md index 205739199..a40f95324 100644 --- a/cookbooks/roundup/README.md +++ b/cookbooks/roundup/README.md @@ -1,34 +1,3 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Roundup 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 is a placeholder cookbook, intended for use with the Roundup Issue Tracker.