From 197aafdf153e54ba32069f906897e27ca65fdd32 Mon Sep 17 00:00:00 2001 From: Alexandre Dulaunoy Date: Tue, 2 Jan 2024 10:48:39 +0100 Subject: [PATCH] chg: [mkdocs] add the contributing part --- tools/mkdocs/REQUIREMENTS | 4 ++++ tools/mkdocs/generator.py | 10 ++++++++++ 2 files changed, 14 insertions(+) create mode 100644 tools/mkdocs/REQUIREMENTS diff --git a/tools/mkdocs/REQUIREMENTS b/tools/mkdocs/REQUIREMENTS new file mode 100644 index 0000000..f42f6c8 --- /dev/null +++ b/tools/mkdocs/REQUIREMENTS @@ -0,0 +1,4 @@ +validators + +mkdocs-git-committers-plugin +mkdocs-rss-plugin diff --git a/tools/mkdocs/generator.py b/tools/mkdocs/generator.py index 7762c20..ce6b797 100644 --- a/tools/mkdocs/generator.py +++ b/tools/mkdocs/generator.py @@ -33,6 +33,15 @@ Clusters serve as an open and freely accessible knowledge base, which can be uti ## Publicly available clusters +""" +index_contributing = """ + +# Contributing + +In the dynamic realm of threat intelligence, a variety of models and approaches exist to systematically organize, categorize, and delineate threat actors, hazards, or activity groups. We embrace innovative methodologies for articulating threat intelligence. The galaxy model is particularly versatile, enabling you to leverage and integrate methodologies that you trust and are already utilizing within your organization or community. + +We encourage collaboration and contributions to the [MISP Galaxy JSON files](https://github.com/MISP/misp-galaxy/). Feel free to fork the project, enhance existing elements or clusters, or introduce new ones. Your insights are valuable - share them with us through a pull-request. + """ galaxy_output = {} @@ -98,6 +107,7 @@ for f in galaxies_fnames: continue galaxy_output[cluster_filename] += f' | `{meta}` |{value["meta"][meta]}|\n' +index_output += index_contributing with open(os.path.join(pathSite, 'index.md'), "w") as index: index.write(index_output)