Installation (Docs)
Wanting to contribute to our lovely documentation? Here are some instructions on how to get the documentation resources setup on your local development environment.
Before you begin
Make sure that you have pip installed by running pip --version
from your terminal. If you don't already have pip, you can install it by following the instructions here. pip is The PyPA recommended tool for installing Python packages.
Setting up your local dev environment for docs
- Create a fork of the main repo into your personal Github account. To learn more about forking, read this guide created by Github.
- Open your favorite terminal application and run
git clone https://github.com/your-git-username/gdi-website.git
to clone YOUR repo to your local machine. - Now run
cd gdi-website/docs
to enter the documentation directory on your local machine. - Run
pip install -r requirements.txt
to install additional packages needed to run the docs server. - Run
mkdocs serve
to start the docs server. - Visit
127.0.0.0:8000
to view the documentation running from your local server.
You now should be able to make edits, save the file and see the edits you've made whenever you refresh the page. Once you have finished making the edits, be sure to follow our contribution guidelines when submitting your pull request!