This repository has been archived by the owner. It is now read-only.
Switch branches/tags
tuned-profiles-openshift-node-0.2.1-1 tuned-profiles-openshift-node-0.1.2-1 tuned-profiles-openshift-node-0.1.1-1 stickshift-selinux-1.0.3-1 stickshift-selinux-1.0.2-1 stickshift-selinux-1.0.1-1 stickshift-selinux-0.1.1-1 stickshift-port-proxy-0.3.3-1 stickshift-port-proxy-0.3.2-1 stickshift-port-proxy-0.3.1-1 stickshift-port-proxy-0.2.4-1 stickshift-port-proxy-0.2.3-1 stickshift-port-proxy-0.2.2-1 stickshift-port-proxy-0.2.1-1 stickshift-port-proxy-0.1.4-1 stickshift-port-proxy-0.1.3-1 stickshift-port-proxy-0.1.2-1 stickshift-port-proxy-0.1.1-1 stickshift-port-proxy-0.0.2-1 stickshift-port-proxy-0.0.1-1 stickshift-mcollective-agent-0.4.3-1 stickshift-mcollective-agent-0.4.2-1 stickshift-mcollective-agent-0.4.1-1 stickshift-mcollective-agent-0.3.2-1 stickshift-mcollective-agent-0.3.1-1 stickshift-mcollective-agent-0.2.2-1 stickshift-mcollective-agent-0.2.1-1 stickshift-mcollective-agent-0.1.6-1 stickshift-mcollective-agent-0.1.5-1 stickshift-mcollective-agent-0.1.4-1 stickshift-mcollective-agent-0.1.3-1 stickshift-mcollective-agent-0.1.2-1 stickshift-mcollective-agent-0.1.1-1 stickshift-mcollective-agent-0.0.5-1 stickshift-mcollective-agent-0.0.4-1 stickshift-mcollective-agent-0.0.3-1 stickshift-mcollective-agent-0.0.2-1 stickshift-mcollective-agent-0.0.1-1 stickshift-broker-0.6.10-1 stickshift-broker-0.6.9-1 stickshift-broker-0.6.8-1 stickshift-broker-0.6.7-1 stickshift-broker-0.6.6-1 stickshift-broker-0.6.5-1 stickshift-broker-0.6.4-1 stickshift-broker-0.6.3-1 stickshift-abstract-0.17.9-1 stickshift-abstract-0.17.8-1 stickshift-abstract-0.17.7-1 stickshift-abstract-0.17.6-1 stickshift-abstract-0.17.5-1 stickshift-abstract-0.17.4-1 stickshift-abstract-0.17.3-1 stickshift-abstract-0.17.2-1 stickshift-abstract-0.17.1-1 stickshift-abstract-0.16.4-1 stickshift-abstract-0.16.3-1 stickshift-abstract-0.16.2-1 stickshift-abstract-0.16.1-1 stickshift-abstract-0.15.7-1 stickshift-abstract-0.15.6-1 stickshift-abstract-0.15.5-1 stickshift-abstract-0.15.4-1 stickshift-abstract-0.15.3-1 stickshift-abstract-0.15.2-1 stickshift-abstract-0.15.1-1 stickshift-abstract-0.14.9-1 stickshift-abstract-0.14.8-1 stickshift-abstract-0.14.6-1 stickshift-abstract-0.14.5-1 stickshift-abstract-0.14.4-1 stickshift-abstract-0.14.3-1 stickshift-abstract-0.14.2-1 stickshift-abstract-0.14.1-1 stickshift-abstract-0.13.7-1 stickshift-abstract-0.13.6-1 stickshift-abstract-0.13.5-1 stickshift-abstract-0.13.4-1 stickshift-abstract-0.13.2-1 stickshift-abstract-0.13.1-1 stickshift-abstract-0.12.5-1 stickshift-abstract-0.12.4-1 stickshift-abstract-0.12.3-1 stickshift-abstract-0.12.2-1 stickshift-abstract-0.12.1-1 stickshift-abstract-0.11.9-1 stickshift-abstract-0.11.8-1 stickshift-abstract-0.11.7-1 stickshift-abstract-0.11.6-1 stickshift-abstract-0.11.5-1 stickshift-abstract-0.11.4-1 stickshift-abstract-0.11.3-1 stickshift-abstract-0.11.2-1 stickshift-abstract-0.11.1-1 stickshift-abstract-0.10.5-1 stickshift-abstract-0.10.4-1 stickshift-abstract-0.10.3-1 stickshift-abstract-0.10.2-1 stickshift-abstract-0.10.1-1 stickshift-abstract-0.9.6-1
Nothing to show
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
files
fonts
images
stylesheets
templates
.gitignore
Gemfile
Guardfile
README.md
Rakefile
_origin_hangouts_footer.adoc
_origin_hangouts_header.adoc
index.adoc
oo_administration_guide.adoc
oo_build_environment_guide.adoc
oo_cartridge_developers_guide.adoc
oo_cartridge_guide.adoc
oo_client_tools_installation_guide.adoc
oo_contributors_guide.adoc
oo_deployment_guide_comprehensive.adoc
oo_deployment_guide_puppet.adoc
oo_deployment_guide_vagrant.adoc
oo_deployment_guide_vm.adoc
oo_install_users_guide.adoc
oo_m4_release_notes.adoc
oo_notes_running_a_local_ddns.adoc
oo_system_architecture_guide.adoc
oo_troubleshooting_guide.adoc
oo_user_guide.adoc
origin_hangouts.csv

README.md

OpenShift Origin Manuals

This repo contains AsciiDoc versions of the OpenShift Origin manuals. The included "index.txt" file is the home page for the complete set of OpenShift Origin documentation.

Building the Manuals

The manuals themselves are .txt files written in AsciiDoc, so they are easily human-readable. However, they are intended to be published in various formats, notably HTML.

build

To generate the HTML document set, first install the necessary gems:

bundle install

Then run the "build" rake task:

bundle exec rake build

This will create html files from the AsciiDoc files, including an index.html.

Note that you may see the following error:

Processing index.txt
asciidoctor: WARNING: line N: include file not found: /path/to/origin-server/documentation/_pep_list.adoc

If you are not working with the openshift-pep repository, you can ignore this.

build_all

When the documentation is deployed to openshift.github.io, this build command:

To make this work in your local build environment, first ensure that you have cloned the openshift-pep repository into the same directory as your clone of the origin-server repository. Then you can run:

bundle exec rake build_all

This task does the following:

  • Copies the REST API documents to documentation/rest_api/
  • Converts the Markdown-based PEPs to HTML via AsciiDoc and writes the generated HTML to the documentation directory.
  • Creates a listing of those files in an AsciiDoc "partial" called _pep_list.adoc.
  • Calls the regular build task to generate the rest of the doc set and include the PEP list in the documentation home page.

You can also trigger just the REST API work and just the PEP work using bundle exec rake build_rest and bundle exec rake build_peps, respectively.

clean

If you want to quickly clean up all of the generated HTML files, run:

bundle exec rake clean

Editing with LivePreview

For ease of editing in AsciiDoc and checking the results in a web browser, a live preview environment has been set up using Guard and LiveReload.

To begin, install the LiveReload extension in your web browser (Firefox, Chrome and Safari are supported). Then build the docs following the [Building the Manuals] instructions.

Next, start the guard process:

bundle exec guard

Now open the html version of a local file that you are working with in your browser and enable the LivePreview add-on for that file.

At this point, you can begin editing the AsciiDoc version of the file in your text editor. Every time you save the AsciiDoc file, you will see output from the guard process as it detects the change and regenerates the HTML file. The LivePreview browser add-on detects the updated file and automatically reloads it into the browser.

Creating New Documents

The build environment is configured to process any file with a ".txt" extension as an AsciiDoc file. At a minimum, the first several lines of a new document must follow this pattern:

= Document Title
Author Name <author.name@example.com>
vN.N, Month YYYY
:data-uri:
:toc2:
:icons:
:numbered:

Start writing your content here.
  • If you do not want the sections of the new document to be auto-numbered, remove the :numbered: line.
  • Be sure to add a link to your document in index.txt or an appropriate referencing document.

For the rest of the document, make sure that you are following proper AsciiDoc syntax and preview your document before submitting a pull request. There's no magic in how the documentation is built, so if it doesn't look right in your sandbox, it won't look right on the documentation site.

Old Manuals

The archive subdirectory contains older manuals that were written in Markdown. Over time, the contents of these files will be updated to AsciiDoc and assimilated into the documents in this directory.