Skip to content
This repository
Browse code

Merge pull request #1273 from fog/doc_updates

Documentation updates
  • Loading branch information...
commit 397b015257a5922298536debe4ebb1eb025152cf 2 parents f4ae7a1 + da9981c
Wesley Beary geemus authored

Showing 2 changed files with 15 additions and 6 deletions. Show diff stats Hide diff stats

  1. +7 3 README.md
  2. +8 3 docs/index.markdown
10 README.md
Source Rendered
@@ -113,11 +113,15 @@ geemus says: "That should give you everything you need to get started, but let m
113 113
114 114 ## Contributing
115 115
116   -* Find something you would like to work on. For suggestions look for the `easy`, `medium` and `hard` tags in the [issues](https://github.com/fog/fog/issues)
  116 +* Find something you would like to work on.
  117 + * Look for anything you can help with in the [issue tracker](https://github.com/fog/fog/issues).
  118 + * Look at the [code quality metrics](https://codeclimate.com/github/fog/fog) for anything you can help clean up.
  119 + * Or anything else!
117 120 * Fork the project and do your work in a topic branch.
118   -* Add a config at `~/.fog` for the component you want to test.
  121 + * Make sure your changes will work on both Ruby 1.8.7 and Ruby 1.9
  122 +* Add a config at `tests/.fog` for the component you want to test.
119 123 * Add shindo tests to prove your code works and run all the tests using `bundle exec rake`.
120   -* Rebase your branch against fog/fog to make sure everything is up to date.
  124 +* Rebase your branch against `fog/fog` to make sure everything is up to date.
121 125 * Commit your changes and send a pull request.
122 126
123 127 ## Additional Resources
11 docs/index.markdown
Source Rendered
@@ -42,10 +42,15 @@ geemus says: "That should give you everything you need to get started, but let m
42 42
43 43 ## Contributing
44 44
45   -* Find something you would like to work on. For suggestions look for the `easy`, `medium` and `hard` tags in the [issues](http://github.com/fog/fog/issues)
  45 +* Find something you would like to work on.
  46 + * Look for anything you can help with in the [issue tracker](https://github.com/fog/fog/issues).
  47 + * Look at the [code quality metrics](https://codeclimate.com/github/fog/fog) for anything you can help clean up.
  48 + * Or anything else!
46 49 * Fork the project and do your work in a topic branch.
  50 + * Make sure your changes will work on both Ruby 1.8.7 and Ruby 1.9.
  51 +* Add a config at `tests/.fog` for the component you want to test.
47 52 * Add shindo tests to prove your code works and run all the tests using `bundle exec rake`.
48   -* Rebase your branch against fog/fog to make sure everything is up to date.
  53 +* Rebase your branch against `fog/fog` to make sure everything is up to date.
49 54 * Commit your changes and send a pull request.
50 55
51 56 ## Resources
@@ -53,7 +58,7 @@ geemus says: "That should give you everything you need to get started, but let m
53 58 Enjoy, and let me know what I can do to continue improving fog!
54 59
55 60 * Work through the [fog tutorial](https://github.com/downloads/geemus/learn_fog/learn_fog.tar.gz)
56   -* Read fog's [API documentation](/rdoc)
  61 +* Read fog's [API documentation](/doc)
57 62 * Stay up to date by following [@fog](http://twitter.com/fog) and/or [@geemus](http://twitter.com/geemus) on Twitter.
58 63 * Get and give help on the [#ruby-fog](irc://irc.freenode.net/ruby-fog) irc channel on Freenode
59 64 * Follow release notes and discussions on the [mailing list](http://groups.google.com/group/ruby-fog)

0 comments on commit 397b015

Please sign in to comment.
Something went wrong with that request. Please try again.