-
Notifications
You must be signed in to change notification settings - Fork 103
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:
- Our wiki: https://github.com/rackerlabs/blueflood/wiki
- Our website: http://blueflood.io
To make edits to the wiki:
- fork the repo: git://github.com/rackerlabs/blueflood.wiki.git
- make edits
- submit a pull request
- 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.
The Blueflood website is also hosted on Github (via Github Pages).
- fork the Blueflood repo: https://github.com/rackerlabs/blueflood.github.com
- clone it locally
- switch to the 'gh-pages' branch
- edit what you will
- submit a PR back to the rackerlabs/blueflood repo
- 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.