From 6af7a48ccc693034adb9f9d913a5e41387f5e067 Mon Sep 17 00:00:00 2001 From: Ivan Smirnov Date: Thu, 25 Jun 2020 15:07:32 -0700 Subject: [PATCH] Add CONTRIBUTING.md - Add requirements for debian hosts - Add section that explains how to add new docs. --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..bf914961 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Contributing + +## Dependencies + +On Debian: + +``` +sudo apt install libpq-dev +pip3 install -r requirements.txt +pip3 install markdown django +``` + +## Adding Documentation + +1. Create the appropriate markdown page under `templates/docs` +2. Add the page to `/templates/front/base_docs.html` +3. Generate the HTML assets with `python3 manage.py render_docs` - note that the `manage.py` is in the root of the project.