Permalink
Browse files

Some fixes in rails guides generation

* Passing edge information to the views fixes the lack of the edge badge
and sets the appropriate welcome page on edgeguides.rubyonrails.org.
* Changes in the welcome message to hyper link the rails tree based on
the version.
* Mention the Amazon url from where kindlegen can be downloaded.
  • Loading branch information...
1 parent 54e522a commit 1acdecf6234b6a8d6dc01d1ada1b8e153c7c60fb @vijaydev vijaydev committed Dec 25, 2011
Showing with 9 additions and 11 deletions.
  1. +3 −3 railties/guides/rails_guides/generator.rb
  2. +6 −8 railties/guides/source/_welcome.html.erb
@@ -49,8 +49,8 @@
#
# KINDLE
# Set to "1" to generate the .mobi with all the guides. The kindlegen
-# executable must be in your PATH. Google for it if you do not have it
-# locally, it is available from Amazon for free.
+# executable must be in your PATH. You can get it for free from
+# http://www.amazon.com/kindlepublishing
#
# ---------------------------------------------------------------------------
@@ -199,7 +199,7 @@ def generate_guide(guide, output_file)
layout = kindle? ? 'kindle/layout' : 'layout'
File.open(output_path, 'w') do |f|
- view = ActionView::Base.new(source_dir, :version => @version, :mobi => "kindle/#{mobi}")
+ view = ActionView::Base.new(source_dir, :edge => @edge, :version => @version, :mobi => "kindle/#{mobi}")
view.extend(Helpers)
if guide =~ /\.(\w+)\.erb$/
@@ -1,21 +1,19 @@
-<h2>Ruby on Rails Guides (<%= @version %>)</h2>
@fxn
fxn Dec 25, 2011 Ruby on Rails member

Why this removal?

@vijaydev
vijaydev Dec 25, 2011 Ruby on Rails member

Edge was already having a link to GH master tree: "based on the current master". Added a similar text to the stable version too (Line 13 below) and added a link there. For the sake of being consistent.

@fxn
fxn Dec 25, 2011 Ruby on Rails member

Ahh, yeah the wording is better, but I think it is good no see the exact version you are looking at in the very title. It's what we have in the stable version now. And with edge we had (edge) before these commits and I changed it to the short sha1 of HEAD to know exactly what are you looking at.

In the case of stable versions it also helps to know what you are looking at when looking at a past release via symlink.

Guides dor Kindle also have the version in the title and file name.

@vijaydev
vijaydev Dec 25, 2011 Ruby on Rails member

Alright, I'll add it back.

+<h2>Ruby on Rails Guides</h2>
<% if @edge %>
<p>
- These are <b>Edge Guides</b>, based on the current
- <a href="https://github.com/rails/rails/tree/master">master branch</a>.
+ These are <b>Edge Guides</b>, based on the current <a href="https://github.com/rails/rails/tree/<%= @version %>">master</a> branch.
</p>
<p>
- If you are looking for the ones for the stable version please check
+ If you are looking for the ones for the stable version, please check
<a href="http://guides.rubyonrails.org">http://guides.rubyonrails.org</a> instead.
</p>
<% else %>
<p>
- These are the new guides for Rails 3. The guides for Rails 2.3 are still available
- at <a href="http://guides.rubyonrails.org/v2.3.11/">http://guides.rubyonrails.org/v2.3.11/</a>.
+ These are the new guides for Rails 3.1 based on <a href="https://github.com/rails/rails/tree/<%= @version %>"><%= @version %></a>.
+ These guides are designed to make you immediately productive with Rails, and to help you understand how all of the pieces fit together.
</p>
<% end %>
<p>
- These guides are designed to make you immediately productive with Rails,
- and to help you understand how all of the pieces fit together.
+ The guides for Rails 2.3.x are available at <a href="http://guides.rubyonrails.org/v2.3.11/">http://guides.rubyonrails.org/v2.3.11/</a>.
</p>

1 comment on commit 1acdecf

@fxn
Member
fxn commented on 1acdecf Dec 25, 2011

Thanks!

Please sign in to comment.