Source for the add on documentation site for OpenShift Container Platform.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github add pull request template Feb 9, 2017
_includes Refactoring docs to use a variable for openshift docs (#251) Feb 12, 2018
_layouts Redirecting playbooks site to uncontained domain (#210) Nov 23, 2017
build Adding initial version of an applier inventory for IaC of the pipeline ( Feb 13, 2018
container-images/local-builder Making some changes to update version of ruby and make pipeline work (#… May 16, 2018
css Redirecting playbooks site to uncontained domain (#210) Nov 23, 2017
deploy Adding initial version of an applier inventory for IaC of the pipeline ( Feb 13, 2018
images Adding a guide to mapping roles and responsibilities in OpenShift (#230) Jan 12, 2018
inventory-dev Making some changes to update version of ruby and make pipeline work (#… May 16, 2018
inventory-prod Adding initial version of an applier inventory for IaC of the pipeline ( Feb 13, 2018
js Integrating with Jekyll for Site generation Nov 30, 2015
playbooks Adding port to external docker registry document (#288) Sep 14, 2018
policy Adding initial version of an applier inventory for IaC of the pipeline ( Feb 13, 2018
projects Uncontained pipeline (#204) Nov 22, 2017
script add --only-4xx flag for htmlproofer (#223) Dec 8, 2017
.gitignore APM guidance (#216) Dec 6, 2017
.htaccess Redirecting playbooks site to uncontained domain (#210) Nov 23, 2017
.travis.yml Making some changes to update version of ruby and make pipeline work (#… May 16, 2018
.travis_id_rsa.enc Travis integration and formatting Apr 2, 2016
Gemfile Making some changes to update version of ruby and make pipeline work (#… May 16, 2018
Jenkinsfile Promotion slave update (#280) Jun 6, 2018
LICENSE Added license file to repository May 26, 2016
README.adoc Going back to ruby 2.4.0 (#211) Nov 23, 2017
_config.yml Uncontained pipeline (#204) Nov 22, 2017
development_guide.adoc Adding updates to development & style guides Mar 14, 2016
index.adoc Adding a guide to mapping roles and responsibilities in OpenShift (#230) Jan 12, 2018
pipeline.md Adding initial version of an applier inventory for IaC of the pipeline ( Feb 13, 2018
style_guide.adoc Updated installation/index.adoc to fix callout (#168) Jun 9, 2017

README.adoc

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

  1. Clone git repositories

    git clone https://github.com/redhat-cop/openshift-playbooks.git
  2. 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
  3. Launch browser and navigate to http://localhost:4000

Quickstart Guide using RHEL (or derivatives)

  1. 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
  2. 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
  3. Install RVM

    Note
    For gnome-terminal users, you’ll need to do this additional step
  4. Install and use Ruby 2.4

    rvm install 2.4.0
    rvm use 2.4.0
  5. Install and set up RubyGems

    rvm rubygems latest
  6. Install bundler

    gem install bundler
  7. Install project dependencies

    bundle install
  8. Build site source

    bundle exec jekyll build
  9. 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