/cf-conventions

Work-in-progress using AsciiDoc

Build Status

Status

This is an unofficial work-in-progress to show how the CF metadata conventions could be managed via GitHub, Travis-CI, and asciidoctor. The output from this process can be seen at: http://cfconventions.org/cf-conventions/cf-conventions.html

For the official web site please visit: http://cfconventions.org/, and the corresponding GitHub organisation: https://github.com/cf-convention.

Building the HTML

To convert the AsciiDoc files into the resulting HTML file:

  1. Ensure you have Ruby installed (e.g. sudo apt-get install ruby)
  2. Ensure you have a recent version of Asciidoctor installed (e.g. gem install asciidoctor)
  3. Get hold of the AsciiDoc files in this repo (e.g. git clone git@github.com:cf-metadata/cf-conventions.git)
  4. Build the HTML: asciidoctor cf-conventions.adoc

See the GitHub help pages and plethora of other git/GitHub guides for more details on how to work with repos, forks, pull requests, etc.