The Engine Yard Docs
This repo holds all the content (and other bits) for the Engine Yard docs, located at EY Docs.
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 EY 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:
Create a new Branch:
git checkout -b <branch-name>
Add your changes
Commit changes to your branch
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:
Clone this repo:
git clone git://github.com/engineyard/ey-docs.git
Ensure that you have Bundler installed:
gem install bundler
Install all pre-requisite gems:
Generate the site and start a local server (This will take a minute. Don't fret.)
bundle exec rake generate # Will generate the files bundle exec rake serve # Will start the gollum-site server
bundle exec rake dev # Generate and run the gollum site in development mode
Navigate to http://localhost:3011/Home.html (Default) to access a fully-functional copy of the EY Docs.
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