Skip to content

Relative links in scanner and hook docs break on DockerHub and ArtifactHub #1963

@o1oo11oo

Description

@o1oo11oo

📚 Documentation Issue

Describe the issue

While trying to cross-reference the Dependency-Track hook and the Trivy SBOM scanner for #1854, I realized that while we usually use relative links in the documentation, this does not work for links embedded in the descriptions of scanners or hooks. The docs for them get automatically generated from .helm-docs.gotmpl, including the README.md files for ArtifactHub and DockerHub. There the relative links without domains won't work.

Where to find the issue

I checked the existing docs for an example and found one in the git-repo-scanner docs, in the following sentence in the "What is Git-Repo-Scanner?" section:

The main purpose of this scanner is to provide a cascading input for the gitleaks and semgrep scanners.

On ArtifactHub the links get removed by their publishing process, on DockerHub the links refer to that page on DockerHub, which of course doesn't exist.

Suggested change

Absolute links would work, but are annoying in development because they always link to production. Maybe we could add a post-processing step that replaces relative links to absolute links for targets that need it?

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions