Merge pull request #66 from harisonmg/add-docs

Add some documentation

Pipfile

@@ -26,6 +26,7 @@ coverage = "*"
 coveralls = "*"
 sphinx = "*"
 sphinx-rtd-theme = "*"
+myst-parser = "*"
 
 [requires]
 

docs/conf.py

@@ -30,7 +30,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = ["myst_parser"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

docs/developer_guide.md

@@ -0,0 +1,31 @@
+# Development installation
+```{admonition} Note
+You should have the following installed and properly configured:
+- Python 3.8 or greater
+- Pipenv
+- Git
+- Firefox
+- Geckodriver
+```
+1. Clone the repo
+1. Open your terminal/command-line and `cd` into the directory containing the repo
+1. Create a `.env` file and add the following environment variables:
+    - `DJANGO_EMAIL_HOST_USER`
+    - `DJANGO_EMAIL_HOST_PASSWORD`
+1. Create a virtual environment and install the **development** dependencies
+    ```shell
+    $ pipenv shell
+    $ pipenv install --dev
+    ```
+
+1. Run the tests to check if everything is installed correctly
+    ```shell
+    # all tests
+    $ python manage.py test
+
+    # functional tests
+    $ python manage.py test --tag=functional
+
+    # non-functional (unit + integration) tests
+    $ python manage.py test --exclude-tag=functional
+    ```

docs/index.rst

@@ -8,4 +8,12 @@ Welcome to Church IMS documentation!
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+   :caption: User documentation
+
+   user_guide
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Developer documentation
+
+   developer_guide

docs/user_guide.md

@@ -0,0 +1,69 @@
+# Self-registration
+## Creating a user account
+1. On the home page, click on the **Sign up** button
+1. Fill the form and submit
+1. Open the email that has been sent to you and click on the email confirmation link
+1. Click on the **Confirm** button
+
+## Adding your personal information
+1. Log in to your account
+1. Fill the form and submit
+
+# Other features
+## Adding a child's records
+```{admonition} Note
+You should have added your personal information
+```
+1. On your navigation menu, click on **Add a child**
+1. Fill the form and submit
+1. If you're not the child's parent, fill the form on the page that you'll be redirected to and submit
+
+## Adding an adult's records
+```{admonition} Note
+You should have the following permissions: `Can add person`, `Can view person`
+```
+1. On your navigation menu, click on **Add an adult**
+1. Fill the form and submit
+
+## Viewing all people's records
+```{admonition} Note
+You should have the following permissions: `Can view person`
+```
+1. On your navigation menu, click on **All people**
+
+## Adding an interpersonal relationship
+```{admonition} Note
+You should have the following permissions: `Can add interpersonal relationship`,
+`Can view interpersonal relationship`
+```
+1. On your navigation menu, click on **Add an interpersonal relationship**
+1. Fill the form and submit
+
+## Viewing all interpersonal relationships
+```{admonition} Note
+You should have the following permissions: `Can view interpersonal relationship`
+```
+1. On your navigation menu, click on **All interpersonal relationships**
+
+
+## Adding a person's temperature record
+```{admonition} Note
+You should have the following permissions: `Can add temperature record`,
+`Can view person`
+```
+1. On your navigation menu, click on **People**
+1. Search for the person's record using their name or username
+1. From the seaech results, click on the **add temp** button for the person
+1. Fill the form and submit
+
+## Password reset
+```{admonition} Note
+You should have to have a user account
+```
+1. On the log in page, click on the **I don't remember my password** link 
+    that is below the **Log in** button.
+1. Enter your email address and submit the form
+1. Open the password reset email that has been sent to the email address
+    you provided in step 2
+1. Click on the password reset link
+1. Fill the form and submit