Introduction

An attempt to improve Rails documentation and make the barrier to entry as low as possible. We periodically publish a list of guides we want at Rails Guides Lighthouse. You can choose the topic you like, submit the guide and win prizes.

How to contribute ?

• Update the respective Lighthouse ticket stating that you will be working on the guide.
• Once your proposal is accepted, the ticket will be put in "taken" state.
• PM lifo at GitHub asking for docrails commit access.
• Commit your guide under railties/doc/guides/src directory. For example, Active Record Basics guide resides at railties/doc/guides/source/active_record_basics.txt
• Put all the images under railties/doc/guides/src/images directory, if any.
• Once the guide is complete, you should update the Lighthouse ticket with the same information and ask for it to be reviewed.

Guides format

• Guides should be in ASCIIDoc format. HTML output is generated by Mizuho.
• Sample guides format : Active Record Associations
• Sample guides output : Active Record Associations

Prizes

For each completed guide, the contributor will receive all of the following prizes:

• $200 from Caboose Rails Documentation Project
• 1 year of GitHub Micro account worth a lot of money.
• 1 year of RPM Basic (Production performance management) for up to 10 hosts worth 12 months x $40 per host x $10 hosts = $4800. And also, savings of $45 per host per month over list price to upgrade to advanced product

Rules

• Guides are licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 License
• We don't want multiple people writing the same guide, hence we allow only one person to be actively writing a guide. However, if you're very interested, please update the Lighthouse ticket anyways. In case the first person backs off, we will contact you
• If there is no/very less activity from the potential guide writer after claiming the guide, we could possibly allocate that guide to another writer
• If the same guide writer wants to write multiple guides, that's ideally the situation we'd love to be in! However, that guide writer will only receive the cash prize for all the subsequent guides
• Our review team will have the final say on whether the guide is complete and of good enough quality

Reviewers

These are the main folks who'll be reviewing your guides, so always listen to them:

• Hongli Lai
• Mike Gunderloy
• Pratik Naik
• Xavier Noria

Editing

To ensure consistent quality and structure, Mike Gunderloy will make a copy editing pass over each guide. To make this easier, all authors should read and follow the Rails Guides Conventions and the Rails API Documentation Conventions.

IRC Channel

#docrails @ irc.freenode.net

Contact

If you need any clarification or want to buy us some beers, feel free to contact :

• IRC : lifo, nzkoz, mikeg1a in #rubyonrails or #rails-contrib
• Email : pratiknaik aT gmail