Git Desktop client (if you prefer a GUI instead of a shell prompt). Suggested applications would be Github Desktop Client, Sourcetree, or Tower (Mac OS X Only).
Checkout Documentation for Editing
If you've never obtained the documentation before you'll want to clone the repository. The default branch is master, this is good.
$ git@github.com:DockDogs/MyDockDogsDashboard.git
If you've already cloned the repository navigate to where this is in your computer using Terminal or Powershell. Once in this directory you'll be able to execute the following:
$ git fetch && git checkout master
How to Edit
Edit files in docs folder using a text editor such as Atom, SublimeText, or Notepad++.
Files are written in reStructuredText syntax.
Deploying Edits to Production Environment
$ git commit -am "commit message documenting what you've changed"
$ git push
Once pushed to master branch Travis-CI will attempt to compile the documentation via a combination of wizardry and science.
If Travis-CI is satisfied that the build compiles properly it will send it for compiling and deployment at ReadTheDocs
Confirm updates are live & accessible via accessing http://help.dockdogs.com. This may take a few minutes to fully deploy, please be patient. Check the Travis-CI page & ReadTheDocs build pages linked above.
