DockDogs Scheduling Documentation

• DockDogs Scheduling Site Documentation. Generated with MKDocs

Pre-requesites

• Git
• MkDocs or check the MkDocs Github Repository
• Python (for using MkDocs)
• Pip (for using/installing MkDocs)
• Text editor such as Atom, Notepad++, or SublimeText.
• Terminal/Powershell access (iTerm2, Terminal.app, etc.)
• 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 where edits should take place.
  • $ git clone [email protected]:DockDogs/dockdogs-scheduling.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 Markdown syntax. Learn more about Markdown syntax at at DaringFireball or Markdown Cheatsheet. Github also has an official Markdown reference guide.

Deploying Edits to Production Environment

• $ mkdocs build
• $ git commit -am "commit message documenting what you've changed"
• $ git push
• Once pushed to master branch all files from site folder will be deployed via Deploybot, Git, and black magic.
• Confirm updates are live & accessible via accessing http://smartsheet.bigairdogs.org. This may take a few minutes to fully deploy, please be patient.

Deployment Status

Getting a Specific Release & Viewing All Releases

• View Releases

Open Issues

• Github Issues