Skip to content

Contributing to documentation

Clemens Lieb edited this page Jan 27, 2018 · 6 revisions

We welcome contributors to the Blueflood documentation with open arms - just as we welcome contributors to the Blueflood codebase!

Our wiki is here:

1. Contributing to the wiki

To make edits to the wiki:

  1. fork the repo: git://github.com/rackerlabs/blueflood.wiki.git
  2. make edits
  3. submit a pull request
  4. feel the warmth and love from an excessively adoring Blueflood team

The wiki is powered by Gollum gollum. For information on Gollum, see the Gollum Readme.

All the wiki documentation is stored in Markdown format. Good tools for editing markdown include Markdownpad on Windows, or Mou for Mac. We also like Sublime Text.

2. Contributing to the website

The Blueflood website is also hosted on Github (via Github Pages).

  1. fork the Blueflood repo: https://github.com/rackerlabs/blueflood.github.com
  2. clone it locally
  3. switch to the 'gh-pages' branch
  4. edit what you will
  5. submit a PR back to the rackerlabs/blueflood repo
  6. receive all the priase and acclaim that the Blueflood team will heap upon you

We will heap as much praise as you dare contribute, we promise.

Like the wiki, the website is written in (mostly) Markdown format. There are a few pieces of Jekyll that come into play and your normal css and all that.

Clone this wiki locally