Skip to content

Commit 5bba15f

Browse files
committed
Some documentation small improvements
1 parent add6bda commit 5bba15f

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Contributing
55
2. Create a named feature branch (`$ git checkout -b my-new-feature`).
66
3. Write your change.
77
4. Write tests for your change (if applicable).
8-
5. Run the tests, ensuring they all pass (`$ bundle exec rake`).
8+
5. [Run the tests](https://github.com/onddo/fs_resize-cookbook/blob/master/TESTING.md), ensuring they all pass (`$ bundle exec rake`).
99
6. Commit your change (`$ git commit -am 'Add some feature'`).
1010
7. Push to the branch (`$ git push origin my-new-feature`).
1111
8. [Submit a Pull Request using Github](https://help.github.com/articles/creating-a-pull-request).

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ Description
55
[![Code Climate](http://img.shields.io/codeclimate/github/onddo/fs_resize-cookbook.svg?style=flat)](https://codeclimate.com/github/onddo/fs_resize-cookbook)
66
[![Build Status](http://img.shields.io/travis/onddo/fs_resize-cookbook.svg?style=flat)](https://travis-ci.org/onddo/fs_resize-cookbook)
77

8-
This Chef cookbook Resizes the file system automatically when the underlying partition or disk increases its size.
8+
This Chef cookbook resizes the file system automatically when the underlying partition or disk increases its size.
99

10-
It is mainly oriented to work with disks in the cloud.
10+
It is mainly oriented to work with cloud or virtual servers where it is common to change the disk size.
1111

1212
Requirements
1313
============
1414

15-
## Platform:
15+
## Platform Requirements
1616

1717
This cookbook has been tested on the following platforms:
1818

@@ -25,7 +25,7 @@ This cookbook has been tested on the following platforms:
2525

2626
Please, [let us know](https://github.com/onddo/fs_resize-cookbook/issues/new?title=I%20have%20used%20it%20successfully%20on%20...) if you use it successfully on any other platform.
2727

28-
## Applications:
28+
## Application Requirements
2929

3030
* Ruby 1.9.3 or higher.
3131

@@ -68,14 +68,14 @@ You can simply include it in a recipe:
6868

6969
```ruby
7070
# in your recipe
71-
include_recipe "fs_resize::default"
71+
include_recipe 'fs_resize'
7272
```
7373

7474
Don't forget to include the `fs_resize` cookbook as a dependency in the metadata:
7575

7676
```ruby
7777
# metadata.rb
78-
depends "fs_resize"
78+
depends 'fs_resize'
7979
```
8080

8181
## Including in the Run List

0 commit comments

Comments
 (0)