SAFETAG is a curricula, a methodology, and a framework for security auditors working with advocacy groups.
This toolkit currently enables users to:
- Deploy and navigate a local version of the SAFETAG content. (See Getting Started Guide)
- Customise SAFETAG content locally and preview changes including
- Modifying the taxonomy
- Modifying activities
- Contribute back your changes. (See Contribution)
- Migrate content from the existing SAFETAG repo. (See Migration)
The SAFETAG framework includes:
- A command line tool to manage content workflows for the SAFETAG project.
- Content packages:
safetag-toolkitcontent package.- (soon)
safetag-guide - (soon)
safetag-curricula
The documentation includes:
- A Getting Started Guide - (view as an online presentation)
- A website about the content as code framework concepts - The SAFETAG Toolkit uses the content as code framework and
docsmith.
The following videos present the safetag toolkit, demonstrate its use and goes through various key tasks in a how to format. You can consult the videos:
- Individually below
- As a playlist
- In a single longer video
An introduction to the Safetag Toolkit video series and the thinking behind this project.
A rapid introduction to a few of the content as code concepts that are applied to the safetag toolkit.
A quick walkthrough how the toolkit works and its basic features.
How to install the toolkit and prerequisites.
Please note that you now need also to install pandoc for your platform.
How to initialise the toolkit on first use.
How to edit content with the Atom editor and preview changes in the browser. Also with a basic description of transclusion.
How to use the category files to organise activities, a basic overview of how to organise content.
How to use the category files to create new taxonomies for organising activities. This currently requires to modify some configuration files but will shortly be streamlined. Follow this issue to be updated #11
How to contribute content to SAFETAG using the new toolkit. This is an advanced topic which requires some basic knowledge of git.
How the community can feedback into the process of further developing the toolkit.
A quick preview of a potential planning feature for SAFETAG auditors. Let us know if you think this should be a priority by answering the Roadmap Survey: https://www.surveymonkey.de/r/G5Q5BF6
Future possible work includes:
- Setup content repository with git to allow:
- Contributions via pull requests
- Content package updates preserving local changes.
- Deeper integration with Atom including
- Linting to enforce consistent markdown style and report errors in real time.
- Audit Planning/Reporting
- Provide audit templates.
- Customise an audit plan.
- Create audit report