This repository contains the official source of the CF metadata conventions. The source files are built into HTML (see below), thw output of which can be seen at: http://cfconventions.org/cf-conventions/cf-conventions.html.
Building the HTML
To convert the AsciiDoc files into the resulting HTML file:
- Ensure you have Ruby installed (e.g.
sudo apt-get install ruby)
- Ensure you have a recent version of Asciidoctor installed (e.g.
gem install asciidoctor)
- Get hold of the AsciiDoc files in this repo (e.g.
git clone email@example.com:cf-metadata/cf-conventions.git)
- Build the HTML:
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.