← 输入框|github.com|刷新
Skip to content

Check docs for all scanners for correctness: Amass #1934

Closed

Description

@malexmave

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
  • 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:

Activity

  1. added
    documentationImprovements or additions to documentation
    scannerImplement or update a security scanner
    on Dec 7, 2021
  2. self-assigned this
    on Jul 21, 2023
  3. Zero3141 commented on Aug 2, 2023

    @Zero3141
    Contributor

    Postponed until we updated Amass to 4.0.1. See #1847

  4. removed their assignment
    on Aug 2, 2023
  5. self-assigned this
    on Sep 1, 2023
  6. Ilyesbdlala commented on Oct 17, 2023

    @Ilyesbdlala
    Member

    Resolved in #1864

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomersscannerImplement or update a security scanner

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions