Merge branch 'master' of github.com:MISP/misp-modules

Makefile

@@ -1,3 +1,4 @@
+# https://www.mkdocs.org/user-guide/deploying-your-docs/
 
 .PHONY: prepare_docs generate_docs ci_generate_docs test_docs
 
@@ -9,11 +10,25 @@ prepare_docs:
 	cp -R doc/logos/* docs/import_mod/logos
 	cp LICENSE docs/license.md
 
-generate_docs: prepare_docs
-	docker run --rm -it -v $(PWD):/docs squidfunk/mkdocs-material build
+install_requirements:
+	pip install -r docs/REQUIREMENTS.txt
 
-ci_generate_docs: prepare_docs
+generate_docs: prepare_docs
 	mkdocs build
 
+deploy:
+	mkdocs gh-deploy
+
 test_docs: prepare_docs
-	docker run --rm -it -p 8000:8000 -v $(PWD):/docs squidfunk/mkdocs-material
+	mkdocs serve
+
+
+# DOCKER make commands
+generate_docs_docker: prepare_docs
+	docker run --rm -it -v $(PWD):/docs squidfunk/mkdocs-material build
+
+deploy_docker:
+	docker run --rm -it -v $(PWD):/docs -v /home/$(whoami)/.docker:/root/.docker:ro squidfunk/mkdocs-material gh-deploy
+
+test_docs_docker: prepare_docs
+	docker run --rm -it -p 8000:8000 -v $(PWD):/docs squidfunk/mkdocs-material

docs/contribute.md

@@ -322,8 +322,9 @@ In order to provide documentation about some modules that require specific input
 - **input** - description of the format of data used in input
 - **output** - description of the format given as the result of the module execution
 
-In addition to the modul documentation please add your module to [docs/index.md](https://github.com/MISP/misp-modules/tree/master/docs/index.md).
+In addition to the module documentation please add your module to [docs/index.md](https://github.com/MISP/misp-modules/tree/master/docs/index.md).
 
+There are also [complementary slides](https://www.misp-project.org/misp-training/3.1-misp-modules.pdf) for the creation of MISP modules.
 
 
 ## Tips for developers creating modules