Curriculum for RailsBridge workshops
Ruby CSS JavaScript HTML
akanshmurthy and rachelmyers Testing curriculum fixes (#625)
* update curriculum based on event feedback

* Add example with receive and not times

* Make matchers description more conversational
Latest commit dca0930 on Mar 16, 2018
Permalink
Failed to load latest commit information.
assets Restore missing orange color on Ruby curriculum 'challenge' headers 9 years ago
lib fix up JS snake game instructions 8 years ago
locales Site index dropdown contains categories like on docs.step 11 years ago
public add bootstrap grid tutorial 10 years ago
sites Testing curriculum fixes (#625) 7 years ago
spec Convert `assert_loosely_equal` helper into an RSpec matcher 9 years ago
.gitattributes Add gitattributes file to force line endings as LF 12 years ago
.gitignore Fix broken "To-Do List" link to point to "Volunteer Opportunities List" 9 years ago
.ruby-version Run the docs on Ruby 2.3.3 now that there's a Railsinstaller version … 9 years ago
.travis.yml Run the docs on Ruby 2.3.3 now that there's a Railsinstaller version … 9 years ago
CONTRIBUTING.md Updating CONTRIBUTING.md to reflect GitHub's changes to a guide and a… 9 years ago
Gemfile Run the docs on Ruby 2.3.3 now that there's a Railsinstaller version … 9 years ago
Gemfile.lock bump gems 8 years ago
LICENSE.md added CC-BY and MIT license to README and LICENSE files 12 years ago
Procfile Add a Procfile so heroku will stop warning about using Webrick 11 years ago
README.md Recommend `bundle exec rake` whenever `rake` is being invoked. 10 years ago
Rakefile Fix typos and some minor syntax things found by RubyMine inspections 11 years ago
app.rb Add frontend starter assets for frontend curriculum 9 years ago
config.ru introduce locale (as sites subdir and optional param), and... 11 years ago
step_file_reference.md Remove OSX Panther instructions 10 years ago

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