cf-convention/cf-conventions

Name: cf-conventions

Owner: CF Conventions

Description: Work-in-progress using AsciiDoc

Created: 2015-06-04 10:35:10.0

Updated: 2018-01-19 16:09:11.0

Pushed: 2017-12-19 12:45:35.0

Homepage:

Size: 4633

Language: null

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

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.