docs: documentation update

[rjaegers]

Pull Request

Description of changes

Checklist

• I have followed the contribution guidelines for this repository
• I have added tests for new behavior, and have not broken any existing tests
• I have added or updated relevant documentation
• I have verified that all added components are accounted for in the SBOM

[github-actions]

Compressed layer size comparison

Comparing ghcr.io/philips-software/amp-devcontainer-rust:latest to ghcr.io/philips-software/amp-devcontainer-rust@sha256:539f7f4f7c54988de0d09b9ac8c097e3336b6b5e6aee7f051f15cb4f0f5b71db

OS/Platform	Previous Size	Current Size	Delta
linux/amd64	459.82M	459.82M	0.00 (+0.00%)
linux/arm64	599.31M	599.31M	0.00 (+0.00%)

[github-actions]

Compressed layer size comparison

Comparing ghcr.io/philips-software/amp-devcontainer-cpp:latest to ghcr.io/philips-software/amp-devcontainer-cpp@sha256:67db33abf5b4d891e6c2650c5e32582156a0be1b2c8c0afacc886bd2aa37ecd1

OS/Platform	Previous Size	Current Size	Delta
linux/amd64	650.48M	650.48M	0.00 (+0.00%)
linux/arm64	643.16M	643.16M	0.00 (+0.00%)

[github-actions]

🦙 MegaLinter status: ✅ SUCCESS

Descriptor	Linter	Files	Fixed	Errors	Elapsed time
✅ ACTION	actionlint	16		0	0.12s
✅ DOCKERFILE	hadolint	2		0	0.69s
✅ GHERKIN	gherkin-lint	2		0	0.96s
✅ JSON	npm-package-json-lint	yes		no	0.48s
✅ JSON	prettier	15	1	0	0.64s
✅ JSON	v8r	14		0	17.22s
✅ MARKDOWN	markdownlint	8	0	0	0.88s
✅ MARKDOWN	markdown-table-formatter	8	0	0	0.26s
✅ REPOSITORY	checkov	yes		no	18.86s
✅ REPOSITORY	gitleaks	yes		no	0.55s
✅ REPOSITORY	git_diff	yes		no	0.02s
✅ REPOSITORY	grype	yes		no	16.13s
✅ REPOSITORY	secretlint	yes		no	1.57s
✅ REPOSITORY	syft	yes		no	0.66s
✅ REPOSITORY	trivy	yes		no	10.71s
✅ REPOSITORY	trivy-sbom	yes		no	0.19s
✅ REPOSITORY	trufflehog	yes		no	3.43s
✅ SPELL	lychee	57		0	1.67s
✅ YAML	prettier	21	0	0	1.01s
✅ YAML	v8r	21		0	12.89s
✅ YAML	yamllint	21		0	0.5s

See detailed report in MegaLinter reports

You could have the same capabilities but better runtime performances if you use a MegaLinter flavor:

• oxsecurity/megalinter/flavors/[email protected] (61 linters)
• oxsecurity/megalinter/flavors/[email protected] (70 linters)

MegaLinter is graciously provided by

[github-actions]

Test Results

 2 files  ±0   2 suites  ±0   1m 22s ⏱️ -1s
29 tests ±0  29 ✅ ±0  0 💤 ±0  0 ❌ ±0 
31 runs  ±0  31 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 1b30eb6. ± Comparison against base commit 7d12cfc.

♻️ This comment has been updated with latest results.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[richardapeters]

Please add a check on having read, understood, and signed-off the Developer Certificate of Origin

[richardapeters]

I don't think we should make this choice for the user