diff options
author | Yves Senn <yves.senn@gmail.com> | 2013-08-19 13:49:35 +0200 |
---|---|---|
committer | Yves Senn <yves.senn@gmail.com> | 2013-08-19 14:00:33 +0200 |
commit | 2fcef6678a02fc03aa3ee18ad2d056e093551bd2 (patch) | |
tree | e74864e0779784a6cf7bf4509b7c851f910ab3d2 /guides/source | |
parent | b0303fd92e11b3fd7b10863ea1e65fffdaeb3e8b (diff) | |
download | rails-2fcef6678a02fc03aa3ee18ad2d056e093551bd2.tar.gz rails-2fcef6678a02fc03aa3ee18ad2d056e093551bd2.tar.bz2 rails-2fcef6678a02fc03aa3ee18ad2d056e093551bd2.zip |
explain how to contribute to the documentation.
Follow-up to #11934
Diffstat (limited to 'guides/source')
-rw-r--r-- | guides/source/contributing_to_ruby_on_rails.md | 6 | ||||
-rw-r--r-- | guides/source/layout.html.erb | 10 |
2 files changed, 7 insertions, 9 deletions
diff --git a/guides/source/contributing_to_ruby_on_rails.md b/guides/source/contributing_to_ruby_on_rails.md index f95a194c30..a0352790f4 100644 --- a/guides/source/contributing_to_ruby_on_rails.md +++ b/guides/source/contributing_to_ruby_on_rails.md @@ -184,7 +184,11 @@ Ruby on Rails has two main sets of documentation: the guides help you in learnin You can help improve the Rails guides by making them more coherent, consistent or readable, adding missing information, correcting factual errors, fixing typos, or bringing it up to date with the latest edge Rails. To get involved in the translation of Rails guides, please see [Translating Rails Guides](https://wiki.github.com/rails/docrails/translating-rails-guides). -You can either push your fix to [Docrails](http://github.com/rails/docrails) (ask the [Rails core team](http://rubyonrails.org/core) for push access if you'd like to contribute regularly), or open a pull request to [Rails](http://github.com/rails/rails) itself. +You can either open a pull request to [Rails](http://github.com/rails/rails) or +ask the [Rails core team](http://rubyonrails.org/core) for commit access on +[docrails](http://github.com/rails/docrails) if you contribute regularly. +Please do not open pull requests in docrails, if you'd like to get feedback on your +change, ask for it in [Rails](http://github.com/rails/rails) instead. Docrails is merged with master regularly, so you are effectively editing the Ruby on Rails documentation. diff --git a/guides/source/layout.html.erb b/guides/source/layout.html.erb index 71d3c5638b..24e1e23497 100644 --- a/guides/source/layout.html.erb +++ b/guides/source/layout.html.erb @@ -101,14 +101,8 @@ You're encouraged to help improve the quality of this guide. </p> <p> - If you see any typos or factual errors that you are confident to fix, - you can push the fix to <%= link_to 'docrails', 'https://github.com/rails/docrails' %> (Ask - the <%= link_to 'Rails core team', 'http://rubyonrails.org/core' %> for push access). - If you choose to open a pull request, please do it in <%= link_to 'Rails', 'https://github.com/rails/rails' %> - and not in the <%= link_to 'docrails', 'https://github.com/rails/docrails' %> repository. - Commits made to docrails are still reviewed, but that happens after you've submitted your - contribution. <%= link_to 'docrails', 'https://github.com/rails/docrails' %> is - cross-merged with master periodically. + Please contribute if you see any typos or factual errors. + To get started, you can read our <%= link_to 'documentation contributions', 'http://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#contributing-to-the-rails-documentation' %> section. </p> <p> You may also find incomplete content, or stuff that is not up to date. |