Skip to content

Commit

Permalink
chg: [mkdocs] add the contributing part
Browse files Browse the repository at this point in the history
  • Loading branch information
adulau committed Jan 2, 2024
1 parent 6207057 commit 197aafd
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
4 changes: 4 additions & 0 deletions tools/mkdocs/REQUIREMENTS
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
validators

mkdocs-git-committers-plugin
mkdocs-rss-plugin
10 changes: 10 additions & 0 deletions tools/mkdocs/generator.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,15 @@
## 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 = {}
Expand Down Expand Up @@ -98,6 +107,7 @@
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)
Expand Down

0 comments on commit 197aafd

Please sign in to comment.