Basic flow of working on the contents

Adding/Editing Contents

  1. Fork https://github.com/ocp-power-automation/extra perhaps naming your fork "power-automation-extra" as an example
  2. git clone https://github.com/<yourid>/power-automation-extra.git
  3. cd power-automation-extra
  4. pip install mkdocs
  5. mkdocs serve - this will start the live-reloading docs server on port 8000, ctrl-c to stop
  6. edit docs under the ./docs subdir with your favorite editor (1 sentence per line)
  7. point your browser to http://localhost:8000
  8. repeat the edit & check until you are happy
  9. git add your changes
  10. git commit -s with good comment
  11. git push to your forked repo
  12. Create a PR against upstream master branch

Reviewing Changes

  1. New (pre-merge) PR submitted by somebody (eg. "pull/27")
  2. Let's say you are in the power-automation-extra directory where origin points to your repo
  3. git remote add upstream https://github.com/ocp-power-automation/extra.git (if you have not done this already)
  4. git fetch upstream pull/27/head:review27 - this creates a remote branch called "review27" in your repo with the PR
  5. git checkout review27 - this downloads the source tree with the PR
  6. mkdocs serve
  7. point your browser to http://localhost:8000

Command References