carols10cents / versioned_rails_guides

A way to generate the rails guides for multiple versions
MIT License
2 stars 0 forks source link

Versioned Rails Guides

Problem: You have legacy projects using versions of Rails that are not the latest. You like to use the Rails Guides for reference. The version of the Rails guides on guides.rubyonrails.org is for a different version of Rails than what your legacy project is running, so sometimes what the guides say doesn't match what you need to do.

Solution:

Generate guides for ALL THE RAILS VERSIONS!!!!

Usage

Run the script:

./versioned-rails-guides.rb

and this will generate the guides for all the rails versions in the 3.2 and 4.0 series, put them on your gh-pages branch on github, and then they will be available to you at http://your-github-username.github.io/versioned_rails_guides. Check out mine (might be out of date)!

Future improvements

I would love help making this more useful -- please see the open issues.

Contributing

Follow Github flow for submitting pull requests. Let me know if you need help with any of those steps <3. There are no tests right now.

I follow the rstat.us contribution policies:

License

MIT. See LICENSE.