Skip to content

Commit

Permalink
Merge branch 'master' of github.com:lifo/docrails
Browse files Browse the repository at this point in the history
  • Loading branch information
vijaydev committed Sep 13, 2011
2 parents ae04fbf + 7b22b01 commit 23fc5fe
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 83 deletions.
2 changes: 1 addition & 1 deletion activesupport/lib/active_support/time_with_zone.rb
Expand Up @@ -12,7 +12,7 @@ module ActiveSupport
# #
# Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)' # Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
# Time.zone.local(2007, 2, 10, 15, 30, 45) # => Sat, 10 Feb 2007 15:30:45 EST -05:00 # Time.zone.local(2007, 2, 10, 15, 30, 45) # => Sat, 10 Feb 2007 15:30:45 EST -05:00
# Time.zone.parse('2007-02-01 15:30:45') # => Sat, 10 Feb 2007 15:30:45 EST -05:00 # Time.zone.parse('2007-02-10 15:30:45') # => Sat, 10 Feb 2007 15:30:45 EST -05:00
# Time.zone.at(1170361845) # => Sat, 10 Feb 2007 15:30:45 EST -05:00 # Time.zone.at(1170361845) # => Sat, 10 Feb 2007 15:30:45 EST -05:00
# Time.zone.now # => Sun, 18 May 2008 13:07:55 EDT -04:00 # Time.zone.now # => Sun, 18 May 2008 13:07:55 EDT -04:00
# Time.utc(2007, 2, 10, 20, 30, 45).in_time_zone # => Sat, 10 Feb 2007 15:30:45 EST -05:00 # Time.utc(2007, 2, 10, 20, 30, 45).in_time_zone # => Sat, 10 Feb 2007 15:30:45 EST -05:00
Expand Down
70 changes: 0 additions & 70 deletions railties/guides/source/contribute.textile

This file was deleted.

10 changes: 6 additions & 4 deletions railties/guides/source/contributing_to_ruby_on_rails.textile
Expand Up @@ -257,16 +257,18 @@ h3. Contributing to the Rails Documentation


Ruby on Rails has two main sets of documentation: The guides help you to learn Ruby on Rails, and the API is a reference. Ruby on Rails has two main sets of documentation: The guides help you to learn Ruby on Rails, and the API is a reference.


You can create an issue in GitHub issues to fix or expand documentation. However, if you're confident about your changes you can push them yourself directly via "docrails":https://github.com/lifo/docrails/tree/master. docrails is a branch with an *open commit policy* and public write access. Commits to docrails are still reviewed, but that happens after they are pushed. docrails is merged with master regularly, so you are effectively editing the Ruby on Rails documentation. You can help improve the Rails guides by making them more coherent, adding missing information, correcting factual errors, fixing typos, 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/lifo/docrails/translating-rails-guides.

If you're confident about your changes, you can push them yourself directly via "docrails":https://github.com/lifo/docrails. docrails is a branch with an *open commit policy* and public write access. Commits to docrails are still reviewed, but that happens after they are pushed. docrails is merged with master regularly, so you are effectively editing the Ruby on Rails documentation.

If you are unsure of the documentation changes, you can create an issue in the "Rails":https://github.com/rails/rails/issues issues tracker on GitHub.


When working with documentation, please take into account the "API Documentation Guidelines":api_documentation_guidelines.html and the "Ruby on Rails Guides Guidelines":ruby_on_rails_guides_guidelines.html. When working with documentation, please take into account the "API Documentation Guidelines":api_documentation_guidelines.html and the "Ruby on Rails Guides Guidelines":ruby_on_rails_guides_guidelines.html.


NOTE: As explained above, ordinary code patches should have proper documentation coverage. docrails is only used for isolated documentation improvements. NOTE: As explained earlier, ordinary code patches should have proper documentation coverage. docrails is only used for isolated documentation improvements.


WARNING: docrails has a very strict policy: no code can be touched whatsoever, no matter how trivial or small the change. Only RDoc and guides can be edited via docrails. Also, CHANGELOGs should never be edited in docrails. WARNING: docrails has a very strict policy: no code can be touched whatsoever, no matter how trivial or small the change. Only RDoc and guides can be edited via docrails. Also, CHANGELOGs should never be edited in docrails.


If you have an idea for a new guide you can refer to the "contribution page":contribute.html for instructions on getting involved.

h3. Contributing to the Rails Code h3. Contributing to the Rails Code


h4. Clone the Rails Repository h4. Clone the Rails Repository
Expand Down
10 changes: 5 additions & 5 deletions railties/guides/source/getting_started.textile
Expand Up @@ -1086,8 +1086,8 @@ def destroy
@post.destroy @post.destroy


respond_to do |format| respond_to do |format|
format.html { redirect_to(posts_url) } format.html { redirect_to posts_url }
format.json { render :json => {}, :status => :ok } format.json { head :ok }
end end
end end
</ruby> </ruby>
Expand Down Expand Up @@ -1456,7 +1456,7 @@ comment to a local variable named the same as the partial, in this case


h4. Rendering a Partial Form h4. Rendering a Partial Form


Lets also move that new comment section out to it's own partial, again, you Let's also move that new comment section out to its own partial. Again, you
create a file +app/views/comments/_form.html.erb+ and in it you put: create a file +app/views/comments/_form.html.erb+ and in it you put:


<erb> <erb>
Expand Down Expand Up @@ -1722,8 +1722,8 @@ This example shows another option of the render helper, being able to pass in
local variables, in this case, we want the local variable +form+ in the partial local variables, in this case, we want the local variable +form+ in the partial
to refer to the +post_form+ object. to refer to the +post_form+ object.


We also add a <tt>@post.tags.build</tt> at the top of this form, this is to make We also add a <tt>@post.tags.build</tt> at the top of this form. This is to make
sure there is a new tag ready to have it's name filled in by the user. If you do sure there is a new tag ready to have its name filled in by the user. If you do
not build the new tag, then the form will not appear as there is no new Tag not build the new tag, then the form will not appear as there is no new Tag
object ready to create. object ready to create.


Expand Down
2 changes: 1 addition & 1 deletion railties/guides/source/initialization.textile
Expand Up @@ -454,7 +454,7 @@ app = eval "Rack::Builder.new {( " + cfgfile + "\n )}.to_app",
TOPLEVEL_BINDING, config TOPLEVEL_BINDING, config
</ruby> </ruby>


The <ruby>initialize</ruby> method will take the block here and execute it within an instance of +Rack::Builder+. This is where the majority of the initialization process of Rails happens. The chain of events that this simple line sets off will be the focus of a large majority of this guide. The +require+ line for +config/environment.rb+ in +config.ru+ is the first to run: The +initialize+ method will take the block here and execute it within an instance of +Rack::Builder+. This is where the majority of the initialization process of Rails happens. The chain of events that this simple line sets off will be the focus of a large majority of this guide. The +require+ line for +config/environment.rb+ in +config.ru+ is the first to run:


<ruby> <ruby>
require ::File.expand_path('../config/environment', __FILE__) require ::File.expand_path('../config/environment', __FILE__)
Expand Down
2 changes: 1 addition & 1 deletion railties/guides/source/layout.html.erb
Expand Up @@ -91,7 +91,7 @@
</dl> </dl>
</div> </div>
</li> </li>
<li><a href="contribute.html">Contribute</a></li> <li><a href="contributing_to_ruby_on_rails.html">Contribute</a></li>
<li><a href="credits.html">Credits</a></li> <li><a href="credits.html">Credits</a></li>
</ul> </ul>
</div> </div>
Expand Down
2 changes: 1 addition & 1 deletion railties/guides/source/rails_on_rack.textile
Expand Up @@ -216,7 +216,7 @@ config.middleware.clear


<ruby> <ruby>
# config.ru # config.ru
use MyOwnStackFromStratch use MyOwnStackFromScratch
run ActionController::Dispatcher.new run ActionController::Dispatcher.new
</ruby> </ruby>


Expand Down

0 comments on commit 23fc5fe

Please sign in to comment.