This website is built using Docusaurus 2, a modern static website generator.
This deploys through GitHub actions!
To use this site locally and see your doc rendered as website, just use the following commands.
npm install
(only initially needed)npm start
This will install all dependencies necessary and run the website on http://localhost:3000/.
We do want to follow a specific style for our markdown based documentation. Therefore, this repository is configured to use a markdown linter. Specific rules are configured via .markdownlint.yaml.
Additionally, there is a npm script lint-doc
, that will lint all the markdown files inside docs and lint-kits
, that will lint all the markdown files inside docs-kits.
This script is also run as a pre-commit hook, set up via husky.
You can also run the linting step manually by running npm run lint-doc
or npm run lint-kits
.
This repository enforces licence compatibility checks on all Pull Requests. This is demanded by TRG 7.04.
Follow these steps if your PR's workflow fails on the action 3rd Party dependency check (Eclipse Dash)
:
[main] ERROR Error response from XYZ HTTP 524
or anything else pointing to
failures in remote services. If that happens, try again tomorrow. If not, continue.java --version
in your bash terminal. For Windows Powershell or command
prompt, this and the following commands may look different but should follow the same structure.java -jar ./org.eclipse.dash.licenses-1.1.0.jar package-lock.json -project automotive.tractusx -summary ./DEPENDENCIES
Adjust the version of the jar if necessary. You should see logs saying [main] INFO Querying X for license data for Y items.
and[main] INFO Found Z items.
DEPENDENCIES
file and push to your branch again.