Documentation Site for OpenShift Playbooks

OpenShift Playbooks is a documentation site for OpenShift, maintained by the OpenShift community and moderated by the North America Emerging Technologies Practice in Red Hat Consulting.

Overview

This site is written in asciidoc format and is built using the Asciidoctor plugin for Jekyll.

Contribution

Quickstart Guide using Docker

Setup Jekyll Asciidoc Docker

Clone git repositories

git clone https://github.com/rhtconsulting/rhc-ose.git
git clone https://github.com/rhtconsulting/openshift-playbooks.git

Create and run Jekyll Asciidoc Docker container

/path/to/rhc-ose/docker/jekyll-asciidoc/run.sh -d=/path/to/openshift-playbooks

Launch browser and find site using default docker-machine IP address, for example:
```
http://<docker_ip>:4000/
```

Quickstart Guide using RHEL (or derivatives)

Install necessary packages.

sudo yum install -y libyaml-devel autoconf gcc-c++ readline-devel zlib-devel libffi-devel openssl-devel automake libtool bison sqlite-devel

Install Node.js Version Manager (nvm — see https://github.com/creationix/nvm)

curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.29.0/install.sh | bash

Install RVM

Note
For gnome-terminal users, you’ll need to do this additional step
Install and use Ruby 2.0
```
rvm install 2.0.0
rvm use 2.0.0
```
Install and set up RubyGems
```
rvm rubygems latest
```
Install bundler
```
gem install bundler
```
Install project dependencies
```
bundle install
```
Build site source
```
bundle exec jekyll build
```
Run local Jekyll server to view site
```
bundle exec jekyll serve
```

Further Development

See our full contribution guide for more details