]> git.openstreetmap.org Git - chef.git/commitdiff
Add more READMEs
authorAndy Allan <andy@gravitystorm.co.uk>
Wed, 13 Jan 2016 17:55:37 +0000 (17:55 +0000)
committerAndy Allan <andy@gravitystorm.co.uk>
Wed, 13 Jan 2016 17:55:37 +0000 (17:55 +0000)
20 files changed:
cookbooks/munin/README.md
cookbooks/mysql/README.md
cookbooks/networking/README.md
cookbooks/nfs/README.md
cookbooks/nginx/README.md
cookbooks/nodejs/README.md
cookbooks/nominatim/README.md
cookbooks/ntp/README.md
cookbooks/ohai/README.md
cookbooks/openssh/README.md
cookbooks/openvpn/README.md
cookbooks/osmosis/README.md
cookbooks/osqa/README.md
cookbooks/otrs/README.md
cookbooks/owl/README.md
cookbooks/passenger/README.md
cookbooks/piwik/README.md
cookbooks/planet/README.md
cookbooks/postgresql/README.md
cookbooks/roundup/README.md

index 205739199955017d846700bb599100dae9f89479..05ae2cd8e0f1caf9489e3789a78f33054e845621 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..0ea9525b06d8f69836728e29485b7a4636a715d2 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..84a58a6fade31d672e30ca1baaa35381c002d0cf 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..da1c028bb9579daf7612d9e642abb9601d0f6640 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..2dff4f5320d535bbfc6712831180c8ca5d2a363d 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..55f8d01d927483d20018453b35a4e0ef9b04383a 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..28c0ff3649def8e13faf0ba31bdcadd2dc195ce2 100644 (file)
@@ -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
index 205739199955017d846700bb599100dae9f89479..f4a94741c254c7561f9a193ac3a7f6eaa5c9b7d5 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..8aed12fba6b4ffc9ba50d175d62e34928861f411 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..75929f5d6fa344b77f21f2fa5b808979f6de6a49 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..4936476c5c6c1464b5adcb5fcd9a1ca9676a7f9a 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..eb1b9b97f5318b5244d82796909a88b41d85a3d3 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..04a39fc395f4137cf18a0fa3c1d5474c4b004377 100644 (file)
@@ -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).
index 205739199955017d846700bb599100dae9f89479..83682298221fc1aebac51ccf72674600897a1889 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..7072e22248a29d5e95eb744aff7903ada9c6e320 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..02cc6ea434fbf7165e58f758f184d89219546a3f 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..a968336a33a8c769c2206ef70a9d0155030b994b 100644 (file)
@@ -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
index 205739199955017d846700bb599100dae9f89479..926c207553d67502c3a656450be98691b0c171de 100644 (file)
@@ -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
index 205739199955017d846700bb599100dae9f89479..7f895005cf081e90668911e61104956eb8acb36d 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..a40f95324e44faaaaf3c43ec7908da6aec0690cd 100644 (file)
@@ -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.