This is the Git repository for documentation related to Red Hat developer SaaS.
The repository contains several "books", each of which is in its own directory. All book directories use the same layout.
Books are organized into folders. Each book’s folder contains:
-
common_content
— symlink to shared-content directory -
content/
— for content (.adoc
files) -
files/
— for downloadable files -
images/
— for images -
docinfo.xml
— Docbook definitions for Pantheon -
master.adoc
— book root
Items in bold
are mandatory, and the rest is optional.
$ export DOCS_VERSION=$(curl -L http://central.maven.org/maven2/io/fabric8/apps/fabric8-online-docs-app/maven-metadata.xml | grep '<latest' | cut -f2 -d">"|cut -f1 -d"<") $ oc apply -f http://central.maven.org/maven2/io/fabric8/apps/fabric8-online-docs-app/$DOCS_VERSION/fabric8-online-docs-app-$DOCS_VERSION-openshift.yml
To build a book, cd
into its directory and compile its master.adoc
using either asciidoctor
(for quick local previews) or ccutil
(to see how the book builds and renders with Red hat branding).
$ *cd _guide-directory_* $ *asciidoctor --doctype=book --section-numbers --attribute=toc master.adoc* $ *_www-browser-of-choice_ master.html*
Substitute <www-browser-of-choice>
for whatever web browser you use.
$ *cd _guide-directory_* $ *ccutil compile --lang en-US --open* This will automatically open the compiled guide in the default web browser.
Bugs and RFEs for Red Hat developer SaaS docs are tracked in the RHDEVDOCS project in the JBoss instance of JIRA at https://issues.jboss.org/browse/RHDEVDOCS.