create_an_ssh_key, diagnostics, misc

Author: alexch

README.md

@@ -4,7 +4,7 @@ Author: Alex Chaffee <mailto:[email protected]>
 
 # Overview
 
-This app creates <http://installfest.heroku.com> which leads students through the various complicated setup instructions for getting Ruby, Rails, Git, etc. installed on whatever combination of computer, OS, and version they happened to bring the the workshop.
+This is a Sinatra app, deployed at <http://installfest.heroku.com>, which leads students through the various complicated setup instructions for getting Ruby, Rails, Git, etc. installed on whatever combination of computer, OS, and version they happened to bring the the workshop.
 
 The site comprises files stored in a "case" directory; the one we care about now is ROOT/cases/installfest.
 
@@ -136,7 +136,7 @@ StepFile is an [Erector](http://erector.rubyforge.org)-based DSL, so if you want
     end
 
 
-# TODO (app)
+# TODO (features)
 
 * big fat checkboxes
 * checking the box should make the step go green
@@ -156,7 +156,15 @@ StepFile is an [Erector](http://erector.rubyforge.org)-based DSL, so if you want
 * add a `tip` directive
 * add a `details` block (nested, maybe collapsed)
 
-## content
+# TODO (technical)
+* upgrade to Erector 0.9
+* test all pages during "startup"
+  * growl if broken
+* 404 should show page with TOC and stuff
+* StepFile object
+* move fonts local
+
+# TODO (content)
 * install ALL the operating systems!
 
 

cases/installfest/create_a_heroku_account.step

@@ -28,11 +28,12 @@ step "Install the heroku gem" do
 end
 
 step "Add your SSH key to your Heroku account" do
+  link "create_an_ssh_key"
   console "heroku keys:add"
   todo "link to ssh key setup instructions"
 end
 
-step "If you have further Heroku issues" do
+tip "If you have further Heroku issues" do
 
   note "try following [<http://support.heroku.com/forums/43117/entries/32505> these directions] to install (or re-install) the `heroku` client."
 

cases/installfest/create_an_ssh_key.step

@@ -0,0 +1,27 @@
+note "An SSH key uniquely identifies you (and your computer) when your computer is communicating with other computers. Think of an SSH key as a fancy password."
+
+note "You'll need one of these to create your Heroku and Github accounts."
+
+important "Be sure to use the same email address that you used when you set up Git."
+
+important "**REPLACE** `[email protected]` with your **actual email address** below."
+
+console "ssh-keygen -C [email protected] -t rsa"
+
+choice "keyphrase" do
+  option "Hit enter to accept blank passphrase, then hit enter again"
+  option "If your computer is shared with other people, as in a work laptop, you should choose and enter a real passphrase. Twice."
+end
+
+todo "expected output of ssh-keygen command"
+
+verify do
+  note "Your brand-new public key is now stored at `~/.ssh/id_rsa.pub`"
+  todo "what is a home directory? what is tilde?"
+  tip "Public vs. Private Keys" do
+    note "If you look inside `~/.ssh/`, you will notice two files with the same name: `id_rsa` and `id_rsa.pub`."
+    note "`id_rsa.pub` is your **public key** and can be shared freely."
+    note "`id_rsa` is your **private key** and must be kept secret."
+    note "If someone else gets your private key and your passphrase, then they can pretend to be you and log on to your Heroku or Github accounts and cause mischief!"
+  end
+end

cases/installfest/diagnostics_for_rvm.step

@@ -0,0 +1,15 @@
+
+
+console "which git"
+result "/usr/local/bin/git"
+
+console "which ruby"
+result "~/.rvm/rubies/ruby-1.9.2-p0/bin/ruby"
+
+console "which rails"
+result "~/.rvm/gems/ruby-1.9.2-p0@global/bin/rails"
+
+console "gem list --local"
+note "this will show a lot of gems... check with a TA to make sure you have all the gems you need"
+
+

cases/installfest/diagnostics_for_windows.step

@@ -0,0 +1,15 @@
+
+
+console "which git"
+todo "result"
+
+console "which ruby"
+todo "result"
+
+console "which rails"
+todo "result"
+
+console "gem list --local"
+note "this will show a lot of gems... check with a TA to make sure you have all the gems you need"
+
+

cases/installfest/get_a_sticker.step

@@ -35,3 +35,5 @@ verify "heroku deploy" do
 
 end
 
+link "diagnostics_for_windows"
+link "diagnostics_for_rvm"

cases/installfest/install_sqlite_manager.step

@@ -9,25 +9,35 @@ step "Install SQLite Manager" do
 
   note "Install the [SQLite Manager](https://addons.mozilla.org/en-US/firefox/addon/5817) Firefox plugin."
 
-  note "If you have trouble installing, follow these detailed instructions:"
+end
 
+step "If you have trouble installing, follow these detailed instructions:" do
+  
+  verify "Your Firefox Version" do
+    note "Open Firefox"
+    note "Select the *Help* menu"
+    note "Click *About Mozilla Firefox*"
+    note "The version number is right under the 'Firefox' title."
+    result "3.6 or higher"
+    note "If you have an old version, [upgrade firefox](http://www.mozilla.com/en-US/firefox/upgrade.html)"
+  end
+  
   note <<-MARKDOWN
 
-* If you already have Firefox installed, verify that it is **version 3.6.13** or greater. (Help -&gt; About Mozilla Firefox. The version number is right under the &quot;Firefox&quot; title.)
-
-* If you don't have Firefox installed, or it's an older version, [<http://www.mozilla.com/en-US/> install Firefox].
-
-* Once it's installed, open Firefox and go to Tools -&gt; Add-ons. At the top of the add-ons window, click &quot;Get Add-ons.&quot;
+* Once it's installed, open Firefox and go to Tools -> Add-ons. At the top of the add-ons window, click "Get Add-ons."
 
-* There will be search box directly underneath &quot;Get Add-ons&quot; that says &quot;Search All Add-ons.&quot; Enter &quot;SQLite&quot; (without the quotes) in the box and hit enter.
+* There will be search box directly underneath "Get Add-ons" that says "Search All Add-ons." Enter `SQLite` in the box and hit enter.
 
-* **SQLite Manager** should be the top result. Click &quot;Add to Firefox...&quot; (If SQLite Manager isn't in the results, check the spelling - SQLite only has one L. Also, check that you have at least Firefox 3.5.)
+* **SQLite Manager** should be the top result. Click "Add to Firefox..." 
 
-* Wait for the countdown, then click &quot;Install Now.&quot;
+  * If SQLite Manager isn't in the results, check the spelling - SQLite only has one L.
 
-* In the Add-ons windows, click &quot;Restart Firefox.&quot;
+* Wait for the countdown, then click "Install Now."
 
-* Once Firefox restarts, the Add-ons window should say &quot;1 new add-on has been installed.&quot; 
+* In the Add-ons window, click "Restart Firefox."
+  * This will preserve the windows you have open, so it should bring you right back to this page.
+  
+* Once Firefox restarts, the Add-ons window should say "1 new add-on has been installed." 
 
   MARKDOWN
 end

cases/installfest/osx_panther.step

@@ -78,32 +78,10 @@ In some cases, SQLite was installed with Rails in the previous section. To check
 
 If the list does not include sqlite3-ruby, do <code>sudo gem install sqlite3-ruby</code> in Terminal app.
 
-**SQLite Manager Firefox add-on**
-
-Step 1 is [<http://www.mozilla.com/en-US/> install Firefox]. Even if it's already installed, you may need to upgrade; the add-on requires 3.5 or greater. ([How to find out which version of Firefox you have](how_to_find_out_which_version_of_firefox_you_have))
-
-Install the SQLite Manager Firefox add-on.
-
-* Open Firefox
-
-* Under the Tools menu, select Add-Ons
-
-* Click Get Add-Ons at the top of the small window that comes up
-
-* In the search box, enter "SQLite" without the quotes
-
-* The first search result should be SQLite Manager.
- * If SQLite Manager is not in the search results, you probably have a version of Firefox that is too old. [<http://www.mozilla.com/en-US/> Install a newer version of Firefox] and then try again to install the add-on.
-
-* Click the "Add to Firefox..." button.
-
-* Click "Install" in the small window that comes up
-
-* Click "Restart Firefox" in the add-ons window to complete the install. This will preserve the windows you have open, so it should bring you right back to this page.
-
-* Once Firefox has restarted, look under the Tools menu. SQLite Manager should be one of the options.
-
   MARKDOWN
+  
+  link "install_sqlite_manager"
+  
   end
 
 step "Install KomodoEdit " do
@@ -115,23 +93,19 @@ step "Other required libraries " do
 sudo gem install rspec rspec-rails cucumber cucumber-rails database_cleaner webrat --no-rdoc --no-ri
 sudo gem install heroku --no-rdoc --no-ri
   BASH
-  end
-
-step "Verify installation " do
-  note <<-MARKDOWN
-
-Make sure you can do everything in the following sections of the [<http://wiki.devchix.com/index.php?title=Server_2003> Windows install directions] (from "Create a Test Application" onwards). Wherever it says "open git bash", substitute "open Terminal."
-
-* [Server_2003#Create_a_test_application|Create a test application](server_2003_create_a_test_application_create_a_test_application)
-
-* [Server_2003#Create a model|Create a model](server_2003_create_a_model_create_a_model)
-
-* [Server_2003#Check test_app in to Local Git|Check test_app in to Local Git](server_2003_check_test_app_in_to_local_git_check_test_app_in_to_local_git)
+end
 
-* [Server_2003#Create_an_ssh_public_key|Create an ssh public key](server_2003_create_an_ssh_public_key_create_an_ssh_public_key)
+step "Create an SSH key" do
+  link "create_an_ssh_key"
+end
 
-* [Server_2003#Create a Heroku Account|Create a Heroku Account](server_2003_create_a_heroku_account_create_a_heroku_account)
+step "Create a Heroku account" do
+  link "create_a_heroku_account"
+end
 
-* [Server_2003#Deploy test_app to Heroku|Deploy test_app to Heroku](server_2003_deploy_test_app_to_heroku_deploy_test_app_to_heroku)
-  MARKDOWN
+step "Verify installation " do
+ todo "create_a_test_application"
+ todo "create_a_model"
+ todo "check_test_app_in_to_local_git"
+ todo "deploy_test_app_to_heroku" 
 end

cases/installfest/osx_snow_leopard.step

@@ -49,49 +49,9 @@ step "Verify successful installation " do
     result "3.0 (or something???)"
   end
 
-  verify "gems" do
-
-    console "gem list --local"
-
-    result <<-PRE
-    *** LOCAL GEMS ***
-
-    actionmailer (2.3.9)
-    actionpack (2.3.9)
-    activerecord (2.3.9)
-    activeresource (2.3.9)
-    activesupport (2.3.9)
-    builder (2.1.2)
-    configuration (1.1.0)
-    cucumber (0.6.2)
-    cucumber-rails (0.2.4)
-    diff-lcs (1.1.2)
-    gherkin (1.0.30)
-    heroku (1.8.0)
-    json (1.2.0) or json_pure (1.4.3)
-    launchy (0.3.5)
-    nokogiri (1.4.1)
-    polyglot (0.3.0) (optional)
-    rack (1.1.0)
-    rails (2.3.5)
-    rake (0.8.7)
-    rest-client (1.3.1)
-    rspec (1.3.0)
-    rspec-rails (1.3.2)
-    sqlite3-ruby (1.2.5)
-    term-ansicolor (1.0.4)
-    treetop (1.4.3) (optional)
-    webrat (0.7.0)
-    PRE
-  end
 end
 
-next_step "create_a_test_application" do
-
-  note <<-MARKDOWN
-**Finally**, make sure you can do everything in the Windows install directions. Wherever it says "git bash", you can mentally substitute "Terminal" - git bash is the name for the Terminal-equivalent program on Windows. I know, strange name!
-  MARKDOWN
-end
+next_step "create_a_test_application"
 
 step "Congratulations!" do
   note "You have everything you need to write a Ruby on Rails application."
@@ -107,7 +67,6 @@ MARKDOWN
   end
 
   step "Destroy the heroku app" do
-
     note "Go to <https://heroku.com/myapps> and then click on your app name. Scroll to the bottom of the page and click Destroy App."
   end
 

cases/installfest/osx_snow_leopard_gcc.step

@@ -179,24 +179,9 @@ We'll be using the KomodoEdit text editor during the workshop, though you are fr
   MARKDOWN
   end
 
-step "Create an ssh public key " do
-  note <<-MARKDOWN
-
-You'll need one of these to create your Heroku account in the next section.
-
-* Open up a new Terminal window.
-<pre>ssh-keygen -C "Your Actual Email" -t rsa</pre> (email should match git config setting)
-
-* Hit enter to accept default location for ssh key.
-
-* Hit enter to accept blank passphrase (if computer is shared with other people, as in a work laptop, you should create a passphrase). Hit enter again to accept blank passphrase (or enter passphrase again).
-
-* [Output of ssh-keygen command](output_of_ssh_keygen_command)
-
-* Your brand-new public key is now stored at <code>~/.ssh/id_rsa.pub</code>.
-
-  MARKDOWN
-  end
+step "Create an ssh public key" do
+  link "create_an_ssh_key"  
+end
 
 step "Create a Heroku Account " do
   link "create_a_heroku_account"
@@ -239,7 +224,9 @@ If "rails server" starts up with no errors, you're golden! It'll look something
 </pre>
 If it does, congratulations! You've successfully installed Ruby AND Rails and started your server. ([Ruby and Rails 3 Diagnostics|Here are some more diagnostics to try if it's not so smooth.](ruby_and_rails_3_diagnostics_here_are_some_more_diagnostics_to_try_if_it_s_not_so_smooth_)) Let's check it in the browser.
 
-* In your browser, go to <http://localhost:3000> ([<http://wiki.devchix.com/images/successful-rails-install.jpg> screenshot of successful install])
+* In your browser, go to <http://localhost:3000>
+
+![Successful Rails Install](http://wiki.devchix.com/images/successful-rails-install.jpg) 
 
 * Back in the Terminal window where you ran <code>rails server</code>, type control-c to kill the server.