Documentation organization
The Kubewarden SBOM Scanner documentation has these parts:
-
Introduction: what SBOM Scanner is.
-
Quick start: install SBOM Scanner and run a first scan.
-
Tutorials: how to verify the signatures of the release, and the user guide, with one page per feature, from registry scans to the MCP server.
-
Explanations: how SBOM Scanner is built and why.
-
How-tos: tasks for the operator, such as Helm values, uninstall, and troubleshooting.
-
Reference: the cluster requirements, the custom resource definitions, and the OpenTelemetry signals.
-
For who?: the people who use SBOM Scanner.
-
Use cases: what each persona does with it.
-
Organization: this page.
-
Glossary: the terms used in these pages.
-
Security disclosure: how to report a vulnerability.
Most of the content is in the Tutorials, Explanations, How-tos, and Reference sections. The sections can overlap. The SBOM Scanner project follows the Diátaxis documentation framework where it can.
Navigation
The menu on the left shows your position in the documentation. The menu on the right lists the sections of the current page. A breadcrumb trail at the top of the page shows the path to the current page.
Other resources
The project also maintains:
-
The RFCs that describe the design decisions of SBOM Scanner.
-
The source repository of SBOM Scanner.
-
The community repository of the Kubewarden project, with its governance and security policy.