Skip to content

Latest commit

 

History

History
97 lines (58 loc) · 4.21 KB

README.md

File metadata and controls

97 lines (58 loc) · 4.21 KB
Raw

The SV Ruby Club Docs

This repo holds all the content (and other bits) for the Silicon Valley Ruby Club documentation, located at SV Ruby Achievements.

Documentation of the SV Ruby Club is written in the tense of Achievements rather than Process. For example, it is an Achievement to Run a club meetup. The description of this Achievement includes the Process for running a club as a template. The documentation of our club is written from the perspective but it is more important that someone did "Run a club meetup" than how it was run.

Participation and progress are more important than Process and Policy.

As each member performs Achievements, they in turn receive Awards/Badges. Each Award they receive represents personal improvement and progressive achievement.

Background to Documentation

The inspiration of this method of documentation came from the awesome guys at Basho who have the Basho Wiki setup with Gollum. It was also inspired by Engine Yard's Docs which Dr Nic was involved with.

We are using Gollum and Gollum-Site to generate the documentation. Gollum is a great piece of open source software released by the GitHub team that lets you maintain and build wikis from the contents of a Git repo.

gollum-site generates html from pages written in any format supported by Gollum (ASCIIDoc, Creole, Markdown, Textile, etc.).

## How to Contribute

Part of the reason we switched to Gollum and GitHub for the SV Ruby docs was to make it easier for people to contribute. Just treat it like a code repo: If you have anything to change or add, simply:

  1. Fork this repo

  2. Build a local copy

  3. Create a new Branch:

     git checkout -b <branch-name>

  4. Add your changes

  5. Commit changes to your branch

  6. Send us a pull request

If it's a small or obvious change, we're likely to merge it right away. If we have questions, we'll communicate with you using the pull request's issue page.

The Gollum README provides a great introduction to using the wiki system.

## Building the Docs Locally

If you want to build and view the EY Docs locally, here is what you need to do:

  1. Clone this repo:

     git clone git://github.com/svruby/svruby-docs.git

  2. Ensure that you have Bundler installed:

     gem install bundler

  3. Install all pre-requisite gems:

     bundle install

  4. Generate the site and start a local server (This will take a minute. Don't fret.)

     gollum-site generate   # Will generate the files
 gollum-site serve      # Will start the gollum-site server

  5. Navigate to http://localhost:8000/Home.html (Default) to access a fully-functional copy of the EY Docs.

Sanitization

You can customize sanitization with three options:

  • --allow_elements: custom elements allowed, comma separated

  • --allow_attributes: custom attributes allowed, comma separated

  • --allow_protocols: custom protocols in href allowed, comma separated

     `$ gollum-site generate --allow_elements embed,object --allow_attributes src --allow_protocols irc`
## Issues, Questions, Comments, Etc.
  • Create a new [Issue][issues]

EY Staff How to Deploy Changes

  • When deploying changes from the CLI make sure to pass the no-migration option ey deploy --no-migrate.
  • When deploying changes from the Web UI make sure that the checkbox next to Migrations is unchecked.