Skip to content

Commit

Permalink
Improve owncloud_test cookbook description
Browse files Browse the repository at this point in the history
  • Loading branch information
zuazo committed Sep 19, 2015
1 parent a6839d4 commit 99c1694
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 81 deletions.
12 changes: 0 additions & 12 deletions test/cookbooks/owncloud_test/CHANGELOG.md

This file was deleted.

69 changes: 1 addition & 68 deletions test/cookbooks/owncloud_test/README.md
Original file line number Diff line number Diff line change
@@ -1,68 +1 @@
owncloud_test Cookbook
======================
TODO: Enter the cookbook description here.

e.g.
This cookbook makes your favorite breakfast sandwhich.

Requirements
------------
TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.

e.g.
#### packages
- `toaster` - owncloud_test needs toaster to brown your bagel.

Attributes
----------
TODO: List you cookbook attributes here.

e.g.
#### owncloud_test::default
<table>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td><tt>['owncloud_test']['bacon']</tt></td>
<td>Boolean</td>
<td>whether to include bacon</td>
<td><tt>true</tt></td>
</tr>
</table>

Usage
-----
#### owncloud_test::default
TODO: Write usage instructions for each cookbook.

e.g.
Just include `owncloud_test` in your node's `run_list`:

```json
{
"name":"my_node",
"run_list": [
"recipe[owncloud_test]"
]
}
```

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 you 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 used with [test-kitchen](http://kitchen.ci/) to test the parent, [owncloud](https://supermarket.chef.io/cookbooks/owncloud) cookbook.
3 changes: 2 additions & 1 deletion test/cookbooks/owncloud_test/metadata.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
maintainer 'Onddo Labs, Sl.'
maintainer_email 'team@onddo.com'
license 'Apache 2.0'
description 'Installs/Configures owncloud_test'
description 'This cookbook is used with test-kitchen to test the parent, '\
'owncloud cookbook'
long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))
version '0.1.0'

Expand Down

0 comments on commit 99c1694

Please sign in to comment.