This repository was archived by the owner on Sep 6, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 10
This repository was archived by the owner on Sep 6, 2023. It is now read-only.
Check docs for all scanners for correctness: WPScan #173
Copy link
Copy link
Closed
secureCodeBox/secureCodeBox
#1871Labels
documentationImprovements or additions to documentationImprovements or additions to documentationmaintainanceEverything related to keeping things in working orderEverything related to keeping things in working orderscanner
Description
Part of the effort to sanity-check all documentation.
Scanner Sanity-Check:
- Sanity Check if the existing documentation is understandable and useful for you as a (first time) user
- Ensure the general chart/scanner description is up to date and consistent to other scanners
./scanner/NAME/.helm-docs.gotmpl -> {{- define "extra.chartAboutSection" -}}
- Ensure the baseline scanner configuration is up to date and consistent to other scanners
./scanner/NAME/.helm-docs.gotmpl -> {{- define "extra.scannerConfigurationSection" -}}
- Ensure there is at minimum one scan example with the following files:
- Example Scan File:
./scanner/NAME/examples/EXAMPLE-NAME/scan.yaml - Example Scan Result File:
./scanner/NAME/examples/EXAMPLE-NAME/findings.yaml
- Example Scan File:
- Ensure the docs files are generated correct and are up to date (sometimes the automated helm-docs update via SCB-Bot failed to update the docs correctly)
./scanner/NAME/readme.md./scanner/NAME/docs/README.ArtifactHub.md./scanner/NAME/docs/README.DockerHub-Parser.md- Optional, only if a dedicated scanner image is defined:
./scanner/NAME/docs/README.DockerHub-Scanner.md
Additional Context:
- SCB Scanner Documentation (based on the above markdown files): https://docs.securecodebox.io/docs/scanners
- SCB DockerHub Images (with description based on docs for each image): https://hub.docker.com/u/securecodebox/
- SCB Artifact Helm Charts: https://artifacthub.io/packages/search?org=securecodebox
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationmaintainanceEverything related to keeping things in working orderEverything related to keeping things in working orderscanner