Curriculum for RailsBridge workshops
Permalink
Failed to load latest commit information.
assets Restore missing orange color on Ruby curriculum 'challenge' headers Feb 5, 2016
lib Fix 'macOS' page to actually exist Aug 3, 2018
locales Site index dropdown contains categories like on docs.step Jul 10, 2014
public Update logos and macOS name on 'choose your OS' page Jul 31, 2018
sites Update the Heroku step to mention heroku rather than heroku-cli Aug 9, 2018
spec Convert `assert_loosely_equal` helper into an RSpec matcher Feb 9, 2016
.gitattributes Add gitattributes file to force line endings as LF Jun 8, 2013
.gitignore Fix broken "To-Do List" link to point to "Volunteer Opportunities List" Feb 6, 2016
.ruby-version Run the docs on Ruby 2.3.3 now that there's a Railsinstaller version … Dec 31, 2016
.travis.yml Run the docs on Ruby 2.3.3 now that there's a Railsinstaller version … Dec 31, 2016
CONTRIBUTING.md Updating CONTRIBUTING.md to reflect GitHub's changes to a guide and a… Jul 23, 2016
Gemfile Run the docs on Ruby 2.3.3 now that there's a Railsinstaller version … Dec 31, 2016
Gemfile.lock bump gems Mar 14, 2017
LICENSE.md added CC-BY and MIT license to README and LICENSE files Jan 10, 2014
Procfile Add a Procfile so heroku will stop warning about using Webrick Oct 6, 2014
README.md Recommend `bundle exec rake` whenever `rake` is being invoked. Aug 14, 2015
Rakefile Fix typos and some minor syntax things found by RubyMine inspections Jun 18, 2014
app.rb Fix 'macOS' page to actually exist Aug 3, 2018
config.ru introduce locale (as sites subdir and optional param), and... Feb 8, 2014
step_file_reference.md Remove OSX Panther instructions Jan 18, 2015

README.md

The RailsBridge Documentation Project

Build Status

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 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/en/installfest, while the intro rails curriculum can be found under ROOT/sites/en/intro-to-rails. (The "en" means "English" -- see "Locales" below.)

These files can be in any of these formats:

(If multiple files exist with the same base name, .step is preferred over .md, and .md over .mw.)

Usage

bundle install
bundle exec rake run

If the above fails (say, because rerun doesn't work on your system), try

rackup

Then open http://localhost:9292 in a web browser, and verify that you can navigate the installfest slides.

Locales

To serve sites from "sites/en", use bundle exec rake run or a vanilla deploy.

To server sites from another locale (say, "es" or Spanish)...

Run Localized Site Locally

$ SITE_LOCALE=es bundle exec rake run

The server listens on 0.0.0.0:9292.

Now you have to set up subdomain mappings for the site. If you have Pow, run:

$ echo 9292 > ~/.pow/railsbridge # works for any subdomain

If you don't have Pow, add the following line to /etc/hosts:

127.0.0.1 es.railsbridge.dev # works for single subdomain

Now you can access http://es.railsbridge.dev:9292 for debugging.

Running on a Server

Just make sure the server responds to a locale subdomain: http://es.railsbridge.org

Temporary Testing

Use a locale or l parameter: http://docs.railsbridge.org/?l=es.

Note that in this mode, links are not rewritten, so if they fail you will have to manually add the parameter again.

Contributing

Check out CONTRIBUTING.md to see how to join our list of contributors!

License

The documentation (including anything under the sites subdir as well as some hardcoded text elsewhere) is licensed under a Creative Commons license (CC-BY, specifically), which means you're welcome to share, remix, or use our content commercially. We just ask for attribution.

The code is licensed under an MIT license, like Ruby itself. Copyright (c) 2010-2014 by RailsBridge.

Other Resources