Merge branch 'master' of github.com:railsbridge/docs

Author: alexch

README.md

@@ -13,21 +13,25 @@ If the above fails (say, because `rerun` doesn't work on your system), try
 
     rackup
 
-Then open <http://localhost:9292> in a web browser.
+Then open <http://localhost:9292> in a web browser, and verify that you can navigate the installfest slides.
 
-If you make any changes, and especially before a pull request, run
+If you expect to make any changes, run
 
-    rake spec
+    bundle exec rake spec
 
-which will run some unit tests and also do syntax validation on all pages, to make sure you didn't break anything.
+which will run the test suite to confirm that you are ready to (preliminarily) validate any changes you make.
 
-When you submit a Pull Request, Travis CI will also run all the tests.
+NOTE:  Before submitting a pull request, you should make sure that you are on a feature branch, in sync with (rebased to) the current upstream master, and that you can cleanly run
+
+    bundle exec rake spec
+
+which will run our standard unit tests and also do syntax validation on all pages, to make sure you didn't break anything.  When you submit a Pull Request, Travis CI will also run all the tests.
 
 # Overview
 
-This is a Sinatra app, deployed at <http://docs.railsbridge.org>. The Railsbridge documentation project is home to a few subprojects, including the Railsbridge installfest instructions, which leads students through the various complicated setup instructions for getting Ruby, Rails, Git, etc. installed on their computer (whatever combination of computer, OS, and version they happened to bring the the workshop!), as well as the Railsbridge workshop "Suggestotron" curriculum.
+This is a Sinatra app, deployed at <http://docs.railsbridge.org>. The RailsBridge documentation project is home to a few subprojects, including the RailsBridge installfest instructions, which leads students through the various complicated setup instructions for getting Ruby, Rails, Git, etc. installed on their computer (whatever combination of computer, OS, and version they happened to bring to the workshop!), as well as the RailsBridge workshop "Suggestotron" curriculum.
 
-Each subproject (a "site") comprises files stored under the "sites" directory; for instance, the installfest instructions are located at ROOT/sites/installfest, while the curriculum can be found under ROOT/sites/curriculum.
+Each subproject (a "site") comprises files stored under the "sites" directory; for instance, the installfest instructions are located at ROOT/sites/installfest, while the standard curriculum can be found under ROOT/sites/curriculum.
 
 These files can be in any of these formats:
 
@@ -46,9 +50,9 @@ StepFile is a new, Ruby-based DSL for describing complex, nested instructions in
 
 [Deck.rb](https://github.com/alexch/deck.rb) converts Markdown files into an interactive in-browser HTML+JavaScript slide deck.
 
-#Organizer Instructions
+#Organizer Instructions (probably outdated -- double check)
 
-Slide contents that change with each workshop are contained in three files under the workshop project. The 'hello and welcome, this is when the breaks are' presentation slides are in current.deck.md. The 'this is what we will learn today' slides are in welcome.deck.md. And the 'this is what we have learned' slides are in closing.deck.md.
+Slide contents that change with each workshop are contained in three files under the workshop project. The 'hello and welcome, this is when the breaks are' presentation slides are in current.deck.md. The 'this is what we will learn today' slides are in welcome.deck.md. And the 'this is what we have learned, and what comes next' slides are in closing.deck.md.
 
 To change those contents, clone this repo, make changes, and then to include your changes in the publicly available repo, send a pull request.
 
@@ -222,6 +226,7 @@ StepFile is an [Erector](http://erector.rubyforge.org)-based DSL, so if you want
 * move fonts local
 
 # TODO (content)
+* pull "organizer" content (from this readme.md) and point to the real stuff they should use
 * install ALL the operating systems!
 * troubleshooting page
 * look into installation scripts

lib/step.rb

@@ -89,7 +89,7 @@ def consider_deploying
     div :class => "deploying" do
       h1 "Deploying"
       blockquote do
-        message "Before the next step, you could try deploying your app to Heroku! Note, that until you reach the stage 'Setting The Default Page', Heroku may tell you 'The page you were looking for doesn't exist'."
+        message "Before the next step, you could try deploying your app to Heroku!"
         link 'deploying_to_heroku'
       end
     end

sites/curriculum/CRUD_with_scaffolding.step

@@ -104,6 +104,4 @@ explanation {
     MARKDOWN
 }
 
-consider_deploying
-
-next_step "voting_on_topics"
+next_step "setting_the_default_page"

sites/curriculum/allow_people_to_vote.step

@@ -71,4 +71,4 @@ explanation {
 
 consider_deploying
 
-next_step "setting_the_default_page"
+next_step "redirect_to_the_topics_list_after_creating_a_new_topic"

sites/curriculum/curriculum.step

@@ -38,8 +38,8 @@ day... unless I really screwed something up. :D
 
 We're going to be working with:
 
-* ruby 1.9.3 installed via rvm (mac or linux) or RailsInstaller (windows)
-* rails 3.2.x
+* ruby 1.9.3 installed via rvm (mac or linux) or RailsInstaller (mac or windows)
+* rails 3.2.x or rails 4.0.x
 * bundler
 * sqlite
 * the text editor of your choice

sites/curriculum/deploying_to_heroku.step

@@ -27,12 +27,13 @@ gem 'sqlite3'
     message "**Remove that line** and replace it with:"
 
     source_code :ruby, <<-RUBY
-group :development do
+group :development, :test do
   gem 'sqlite3'
 end
 
 group :production do
   gem 'pg'
+  gem 'rails_12factor'
 end
     RUBY
   end

sites/curriculum/hooking_up_votes_and_topics.step

@@ -23,7 +23,6 @@ steps {
 
     source_code :ruby, <<-RUBY
 class Topic < ActiveRecord::Base
-  attr_accessible :description, :title
   has_many :votes, dependent: :destroy
 end
     RUBY
@@ -33,7 +32,6 @@ end
     message "Edit `app/models/vote.rb` so that it looks like this:"
     source_code :ruby, <<-RUBY
 class Vote < ActiveRecord::Base
-  attr_accessible :topic_id
   belongs_to :topic
 end
     RUBY

sites/curriculum/img/rails4_rails_info_routing.png

@@ -30,6 +30,4 @@ explanation do
   message "Control+C is a way of closing or cancelling terminal programs. Since rails server runs forever, you need to interrupt it with Control+C."
 end
 
-consider_deploying
-
 next_step "creating_a_migration"

sites/curriculum/running_your_application_locally.step

@@ -13,20 +13,16 @@ goals {
 steps {
 
   step "Add a root route" do
-    message "Open `config/routes.rb`. Near the end of the file but before the final end add `root :to => 'topics#index'`. When you are done the last few lines should look like this:"
+    message "Open `config/routes.rb`. Search the file for 'root' (near the top) uncomment that line and change it to read  `root 'topics#index'`. When you are done the line should look like this:"
 
-    source_code :ruby, <<-RUBY
-root :to => 'topics#index'
-    RUBY
-  end
+    message "(Rails 3.x users should add `root to: 'topics#index'` and will need to remove their `public/index.html` file)."
 
-  step "Remove the static welcome file" do
-
-    message "  You also need to remove the welcome aboard page for the new route to work."
+  end
 
-    console "git rm public/index.html"
+    source_code :ruby, <<-RUBY
+root 'topics#index'
+    RUBY
 
-  end
 
   step "Confirm your changes" do
     message "Go back to <http://localhost:3000/>. You should be taken to the topics list automatically."
@@ -36,7 +32,7 @@ root :to => 'topics#index'
 explanation {
 
  message <<-MARKDOWN
-  * `root :to => 'topics#index'` is a rails route that says the default
+  * `root 'topics#index'` is a rails route that says the default
     address for your site is `topics#index`. `topics#index` is the topics
     list page (the topics controller with the index action).
   * Rails routes control how URLs (web addresses) get matched with
@@ -54,24 +50,25 @@ explanation {
   ````
     $ rake routes
 
-         votes GET    /votes(.:format)           votes#index
-               POST   /votes(.:format)           votes#create
-      new_vote GET    /votes/new(.:format)       votes#new
-     edit_vote GET    /votes/:id/edit(.:format)  votes#edit
-          vote GET    /votes/:id(.:format)       votes#show
-               PUT    /votes/:id(.:format)       votes#update
-               DELETE /votes/:id(.:format)       votes#destroy
+        Prefix Verb   URI Pattern                Controller#Action
         topics GET    /topics(.:format)          topics#index
                POST   /topics(.:format)          topics#create
      new_topic GET    /topics/new(.:format)      topics#new
     edit_topic GET    /topics/:id/edit(.:format) topics#edit
          topic GET    /topics/:id(.:format)      topics#show
+               PATCH  /topics/:id(.:format)      topics#update
                PUT    /topics/:id(.:format)      topics#update
                DELETE /topics/:id(.:format)      topics#destroy
-          root        /                          topics#index
+          root GET    /                          topics#index
   ````
   This shows all the URLs your application responds to. The code that starts with colons are variables so :id means the id number of the record. The code in parenthesis is optional.
 
+  In Rails 4, you can also get this information on your site in development. Go to <a href="http://localhost:3000/rails/info">http://localhost:3000/rails/info</a> and you'll see something like this:
+
+  <img src='img/rails4_rails_info_routing.png'>
+
+  You'll also see that table in Rails 4 whenever you try to access an invalid route (try <a href="http://localhost:3000/sandwich">http://localhost:3000/sandwich</a>)
+
 ### Exploring Routes (optional)
 
   Now you can have a look at the paths that are available in your app.
@@ -92,4 +89,6 @@ explanation {
   MARKDOWN
 }
 
-next_step "redirect_to_the_topics_list_after_creating_a_new_topic"
+consider_deploying
+
+next_step "voting_on_topics"