Merge pull request #295 from mapswipe/docs

Add contributing guidelines to README & Change certbot renewal setup docs.

Author: Matthias-Schaub

README.md

@@ -15,17 +15,48 @@ Please refer to the documentation for more information: https://mapswipe-workers
 
 ## Ressources
 
-- GitHub repository of the MapSwipe Back-End: https://github.com/mapswipe/python-mapswipe-workers
-- GitHub repository of the MapSwipe Website: https://github.com/mapswipe/mapswipe.github.io
-- GitHub repository of the MapSwipe App https://github.com/mapswipe/mapswipe
-- Website of MapSwipe: https://mapswipe.org
-- OSM-Wiki page of MapSwipe: https://wiki.openstreetmap.org/wiki/MapSwipe
+- MapSwipe Back-End: https://github.com/mapswipe/python-mapswipe-workers
+- MapSwipe App https://github.com/mapswipe/mapswipe
+- MapSwipe Website: https://mapswipe.org
+- MapSwipe OSM-Wiki: https://wiki.openstreetmap.org/wiki/MapSwipe
+
+
+## Contributing Guidelines
+
+### Feature Branch
+
+To contribute to the MapSwipe back-end please create dedicated feature branches based on the `dev` branch. After the changes create a Pull Request of the `feature` branch into the `dev` branch on GitHub:
+
+```bash
+git checkout dev
+git checkout -b featureA
+# Hack away ...
+git commit -am 'Describe changes.'
+git push -u origin featureA
+# Create a Pull Request from feature branch into the dev branch on GitHub.
+```
+
+> Note: If a bug in production (master branch) needs fixing before a new versions of MapSwipe Workers gets released (merging dev into master branch), a hotfix branch should be created. In the hotfix branch the bug should be fixed and then merged with the master branch (and also dev).
+
+
+### Style Guide
+
+This project uses [black](https://github.com/psf/black) and [flake8](https://gitlab.com/pycqa/flake8) to achieve a unified style.
+
+Use [pre-commit](https://pre-commit.com/) to run `black` and `flake8` prior to any git commit. `pre-commit`, `black` and `flake8` should already be installed in your virtual environment since they are listed in `requirements.txt`. To setup pre-commit simply run:
+
+```
+pre-commit install
+```
+
+From now on `black` and `flake8` should run automatically whenever `git commit` is executed.
 
 
 ## License
 
 This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details
 
+
 ## Authors
 
 * **Benjamin Herfort** - HeiGIT - [Hagellach37](https://github.com/Hagellach37)
@@ -34,6 +65,7 @@ This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENS
 
 See also the list of [contributors](contributors.md) who participated in this project.
 
+
 ## Acknowledgements
 
 * Humanitarian organizations can't help people if they can't find them.

docs/source/installation.md

@@ -251,28 +251,16 @@ certbot certonly \
     --non-interactive
 ```
 
+> Note: Certbot systemd timer for renewal of certificate will not work for standalone certificates because the service (docker nginx) which occupies port 80 has to be stopped before renewal.
 
-Enable and start Certbot systemd timer for renewal of certificates:
+For certificate renewal a cronjob is used:
 
 ```bash
-systemctl enable certbot.timer
-systemctl start certbot.timer
-# To check if certbot.timer is enabled run:
-systemctl list-units --type timer | grep certbot
-```
-
-Add renewal post hook to reload nginx after certificate renwal:
-
-- `mkdir -p /etc/letsencrypt/renewal-hooks/deploy`
-- `vim /etc/letsencrypt/renewal-hooks/deploy/nginx`
+SHELL=/bin/sh
+PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
 
+0 */12 * * * certbot -q renew --pre-hook "docker stop nginx" --post-hook "docker start nginx"
 ```
-#!/usr/bin/env bash
-
-docker container restart nginx
-```
-
-- `chmod +x /etc/letsencrypt/renewal-hooks/deploy/nginx`
 
 
 ### Nginx