Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 1.21 KB

README.md

File metadata and controls

28 lines (20 loc) · 1.21 KB

Better read in BOOK format..

Building this booklet locally

The content of this repository is written with markdown files, packaged with MkDocs and can be built into a book-readable format by MkDocs build processes.

  1. Install MkDocs locally following the official documentation instructions.
  2. Install Material plugin for mkdocs: pip install mkdocs-material
  3. git clone https://github.com/jbcodeforce/openshift-studies.git (or your forked repository if you plan to edit)
  4. cd openshift-studies
  5. mkdocs serve
  6. Go to http://127.0.0.1:8000/ in your browser.

Pushing the book to GitHub Pages

  1. Ensure that all your local changes to the master branch have been committed and pushed to the remote repository.
    1. git push origin master
  2. Ensure that you have the latest commits to the gh-pages branch, so you can get others' updates.
    git checkout gh-pages
    git pull origin gh-pages
    
    git checkout master
  3. Run mkdocs gh-deploy from the root openshift-studies directory.