Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix dead links #7998

Merged
merged 1 commit into from
Nov 26, 2024
Merged

docs: fix dead links #7998

merged 1 commit into from
Nov 26, 2024

Conversation

knqyf263
Copy link
Collaborator

Description

Fix dead links

Before

INFO    -  Doc file 'community/maintainer/triage.md' contains an absolute link '/docs/community/maintainer/help-wanted.md', it was left as is.
INFO    -  Doc file 'docs/advanced/air-gap.md' contains an unrecognized relative link '../supply-chain/vex/repo/#configuration-file', it was left as is. Did you mean '../supply-chain/vex/repo.md#configuration-file'?
INFO    -  Doc file 'docs/advanced/air-gap.md' contains an unrecognized relative link '../supply-chain/vex/repo/#custom-repositories', it was left as is. Did you mean '../supply-chain/vex/repo.md#custom-repositories'?
INFO    -  Doc file 'docs/advanced/air-gap.md' contains an unrecognized relative link '../supply-chain/vex/repo/#authentication', it was left as is. Did you mean '../supply-chain/vex/repo.md#authentication'?
WARNING -  Doc file 'docs/compliance/compliance.md' contains a link '../target/aws.md#compliance', but the target 'docs/target/aws.md' is not found among documentation files.
INFO    -  Doc file 'docs/compliance/contrib-compliance.md' contains an unrecognized relative link '../../docs/compliance/compliance/#custom-compliance', it was left as is. Did you mean 'compliance.md#custom-compliance'?
INFO    -  Doc file 'docs/compliance/contrib-compliance.md' contains an unrecognized relative link './compliance/#custom-compliance', it was left as is. Did you mean 'compliance.md#custom-compliance'?
INFO    -  Doc file 'docs/references/troubleshooting.md' contains an unrecognized relative link '../../vulnerability/examples/cache/#cache-backend', it was left as is.
INFO    -  Doc file 'docs/scanner/vulnerability.md' contains an unrecognized relative link '../supply-chain/attestation/rekor/#non-packaged-binaries', it was left as is. Did you mean '../supply-chain/attestation/rekor.md#non-packaged-binaries'?
INFO    -  Doc file 'docs/scanner/vulnerability.md' contains an unrecognized relative link '../coverage/language/golang/#go-binaries', it was left as is. Did you mean '../coverage/language/golang.md#go-binaries'?
INFO    -  Doc file 'docs/scanner/vulnerability.md' contains an unrecognized relative link '../coverage/language/rust/#binaries', it was left as is. Did you mean '../coverage/language/rust.md#binaries'?
INFO    -  Doc file 'docs/scanner/vulnerability.md' contains an unrecognized relative link '../supply-chain/container-image/#sbom-embedded-in-container-images', it was left as is.
INFO    -  Doc file 'docs/scanner/misconfiguration/check/builtin.md' contains an unrecognized relative link 'opa-bundle', it was left as is.
INFO    -  Doc file 'community/maintainer/release-flow.md' contains a link '#manual-release', but there is no such anchor on this page.
INFO    -  Doc file 'docs/configuration/reporting.md' contains a link '../coverage/language/golang.md#go-modules', but the doc 'docs/coverage/language/golang.md' does not contain an anchor '#go-modules'.
INFO    -  Doc file 'docs/configuration/reporting.md' contains a link '../coverage/language/php.md#composer', but the doc 'docs/coverage/language/php.md' does not contain an anchor '#composer'.
INFO    -  Doc file 'docs/coverage/kubernetes.md' contains a link '#KBOM', but there is no such anchor on this page.
INFO    -  Doc file 'docs/coverage/language/index.md' contains a link '#fnref:8', but there is no such anchor on this page. This seems to be a footnote that is never referenced.
INFO    -  Doc file 'docs/coverage/language/golang.md' contains a link '#standard-library-1', but there is no such anchor on this page.
INFO    -  Doc file 'docs/coverage/language/golang.md' contains a link '#main-module-1', but there is no such anchor on this page.
INFO    -  Doc file 'docs/coverage/language/golang.md' contains a link '../../scanner/vulnerability.md#data-sources-1', but the doc 'docs/scanner/vulnerability.md' does not contain an anchor '#data-sources-1'.
INFO    -  Doc file 'docs/coverage/language/java.md' contains a link '../../scanner/vulnerability.md#data-sources-1', but the doc 'docs/scanner/vulnerability.md' does not contain an anchor '#data-sources-1'.
INFO    -  Doc file 'docs/coverage/language/python.md' contains a link '#detection-priority', but there is no such anchor on this page.
INFO    -  Doc file 'docs/target/sbom.md' contains a link './kubernetes.md#KBOM', but the doc 'docs/target/kubernetes.md' does not contain an anchor '#KBOM'.
INFO    -  Doc file 'tutorials/kubernetes/cluster-scanning.md' contains a link '../../docs/target/kubernetes.md#trivy-operator', but the doc 'docs/target/kubernetes.md' does not contain an anchor '#trivy-operator'.

After

INFO    -  Doc file 'docs/advanced/air-gap.md' contains an unrecognized relative link '../supply-chain/vex/repo/#configuration-file', it was left as is. Did you mean '../supply-chain/vex/repo.md#configuration-file'?
INFO    -  Doc file 'docs/advanced/air-gap.md' contains an unrecognized relative link '../supply-chain/vex/repo/#custom-repositories', it was left as is. Did you mean '../supply-chain/vex/repo.md#custom-repositories'?
INFO    -  Doc file 'docs/advanced/air-gap.md' contains an unrecognized relative link '../supply-chain/vex/repo/#authentication', it was left as is. Did you mean '../supply-chain/vex/repo.md#authentication'?

I didn't fix the Air-gapped document as it will be updated soon in #7732

Checklist

  • I've read the guidelines for contributing to this repository.
  • I've followed the conventions in the PR title.
  • I've added tests that prove my fix is effective or that my feature works.
  • I've updated the documentation with the relevant information (if needed).
  • I've added usage information (if the PR introduces new options)
  • I've included a "before" and "after" example to the description (if the PR is a user interface change).

Signed-off-by: knqyf263 <[email protected]>
@knqyf263 knqyf263 self-assigned this Nov 26, 2024
@knqyf263 knqyf263 added the kind/documentation Categorizes issue or PR as related to documentation. label Nov 26, 2024
@simar7 simar7 added this pull request to the merge queue Nov 26, 2024
Merged via the queue into aquasecurity:main with commit ad0ff5d Nov 26, 2024
7 checks passed
@knqyf263 knqyf263 deleted the docs/fix_links branch November 27, 2024 05:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants