/ocp-power-automation.github.io

Documentation for Infrastructure as Code patterns used OpenShift deployment on Power Systems

Apache License 2.0Apache-2.0

How to publish the documentation as github page

  1. Clone git@github.com:ocp-power-automation/ocp-power-automation.github.io.git and make changes 
    git clone --recurse-submodules  git@github.com:ocp-power-automation/ocp-power-automation.github.io.git
  2. Validate changes by creating a local server 
    $ cd ocp-power-automation/ocp-power-automation.github.io
$ mkdocs serve

connect to http://127.0.0.1:8000 and validate the changes
  3. Commit the changes to git@github.com:ocp-power-automation/ocp-power-automation.github.io.git
  4. Run following command to create the github page 
        $ mkdocs gh-deploy --config-file  ./mkdocs.yml
    This will update the gh-pages branch in git@github.com:ocp-power-automation/ocp-power-automation.github.io.git. Refer https://www.mkdocs.org/user-guide/ for mkdocs documentation.