About
This repository contains source code for the Trustworthy Platform Module (TwPM) documentation webpage
Contribution
Please make sure to follow the steps below before publishing your changes as a merge request.
Local build
virtualenv -p $(which python3) venv
source venv/bin/activate
pip install -r requirements.txt
mkdocs serve
By default, it will host a local copy od documentation at:
http://0.0.0.0:8000/
.
It is very important at this point to verify that the pages you have changed render correctly as HTML in local preview.
Make sure no TBD or TODO content is displayed
Find all occurrences:
grep -E "TBD|TODO" docs/**/*.md -r
Iterate over all occurrences and check if:
- file, where TBD or TODO occurs, is displayed (included in nav section of mkdocs.yml)
- TBD or TODO is visible on the website
There should be no TBD or TODO visible on the website.
pre-commit hooks
-
Install pre-commit, if you followed local build procedure
pre-commit
should be installed -
Install hooks into repo:
pre-commit install --hook-type commit-msg
-
Enjoy automatic checks on each
git commit
action! -
(Optional) Run hooks on all files (for example, when adding new hooks or configuring existing ones):
pre-commit run --all-files
To skip verification
In some cases, it may be needed to skip pre-commit
tests. To do that, please
use:
git commit --no-verify
Funding
This project was partially funded through the NGI Assure Fund, a fund established by NLnet with financial support from the European Commission's Next Generation Internet programme, under the aegis of DG Communications Networks, Content and Technology under grant agreement No 957073.