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
-
Clone git repositories
git clone https://github.com/redhat-cop/openshift-playbooks.git
-
Start Site Builder Container
cd openshift-playbooks docker run \ -u `id -u` -it \ -v $PWD/:/home/jekyll/src/:Z \ -p 4000:4000 \ redhatcop/jekyll-local-builder
-
Launch browser and navigate to
http://localhost: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
-
Note
For gnome-terminalusers, you’ll need to do this additional step -
Install and use Ruby 2.4
rvm install 2.4.0 rvm use 2.4.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
Building the Image
cd container-images/local-builder
docker build -t redhatcop/jekyll-local-builder:latest .Further Development
See our full contribution guide for more details