Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 637 Bytes

CONTRIBUTING.md

File metadata and controls

33 lines (25 loc) · 637 Bytes

Contributing

When working on the workshops, we advise that you review your changes locally before committing them.

Use mkdocs serve live preview your changes (as you type) on your local machine.

Use deploy.sh to deploy when you have completed your changes.

To setup the first time

cd workshops
python3 -m venv venv
source venv/bin/activate
source ./buildtools/mkdocs-setup.sh

If needed- for each new session setup

cd workshops
source venv/bin/activate

To debug

mkdocs serve

You can then view the site on localhost:8000

To deploy

source ./buildtools/mkdocs-deploy.sh