This repository contains source code for the Trustworthy Platform Module (TwPM) documentation webpage
Please make sure to follow the steps below before publishing your changes as a merge request.
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.
Find all occurrences:
grep -E "TBD|TODO" docs/**/*.md -r
Iterate over all occurrences and check if:
There should be no TBD or TODO visible on the website.
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
In some cases, it may be needed to skip pre-commit
tests. To do that, please
use:
git commit --no-verify
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.