aquasecurity / trivy

Find vulnerabilities, misconfigurations, secrets, SBOM in containers, Kubernetes, code repositories, clouds and more
https://aquasecurity.github.io/trivy
Apache License 2.0
22.92k stars 2.26k forks source link

docs: fix broken links #4947

Open nikpivkin opened 1 year ago

nikpivkin commented 1 year ago

Build docs:

docker build -t mkdocs docs/build/
docker run --rm -it --entrypoint=/bin/sh -v ${PWD}:/docs mkdocs
mike deploy --update-aliases v0.44

Run lychee:

docker run --init -it --rm -w /docs -v $(pwd)/site:/docs lycheeverse/lychee . --exclude "https://fonts.gstatic.com" --exclude "https://twitter.com/AquaTrivy" --exclude "file:///trivy/v0.44" --exlucde "http://localhost:8000" --exclude ".*@.*" --exclude "file://.*"
....
Issues found in 18 inputs. Find details below.

[./ecosystem/ide/index.html]:
✗ [404] https://docs.rancherdesktop.io/getting-started/features#scanning-images | Failed: Network error: Not Found

[./community/contribute/discussion/index.html]:
✗ [404] https://aquasecurity.github.io/trivy/latest/docs/vulnerability/detection/data-source/ | Failed: Network error: Not Found
✗ [403] https://gitlab.com/gitlab-org/security-products/gemnasium-db/-/issues/new | Failed: Network error: Forbidden

[./docs/advanced/modules/index.html]:
✗ [404] https://oras.land/cli/ | Failed: Network error: Not Found

[./docs/supply-chain/attestation/sbom/index.html]:
✗ [404] https://docs.sigstore.dev/cosign/key-generation | Failed: Network error: Not Found

[./docs/scanner/misconfiguration/policy/exceptions/index.html]:
✗ [404] https://github.com/aquasecurity/trivy/tree/b12d1a70364290579dc0e6ca444d35edc490c7d2/examples/misconf/namespace-exception | Failed: Network error: Not Found
✗ [404] https://github.com/aquasecurity/defsec/blob/master/internal/rules/kubernetes/policies/pss/restricted/3_runs_as_root.rego | Failed: Network error: Not Found
✗ [404] https://github.com/aquasecurity/trivy/tree/b12d1a70364290579dc0e6ca444d35edc490c7d2/examples/misconf/rule-exception | Failed: Network error: Not Found

[./tutorials/additional-resources/community/index.html]:
✗ [ERR] https://www.a10o.net/devsecops/docker-image-security-static-analysis-tool-comparison-anchore-engine-vs-clair-vs-trivy/ | Failed: Network error: error:1416F086:SSL routines:tls_process_server_certificate:certificate verify failed:ssl/statem/statem_clnt.c:1921: (unable to get local issuer certificate)

[./docs/scanner/misconfiguration/custom/schema/index.html]:
✗ [404] https://www.openpolicyagent.org/docs/latest/schemas/#schema-annotations | Failed: Network error: Not Found

[./docs/scanner/vulnerability/os/index.html]:
✗ [404] https://developers.redhat.com/products/rhel/ubi%C2%A0 | Failed: Network error: Not Found
✗ [404] https://github.com/GoogleContainerTools/distroless%C2%A0 | Failed: Network error: Not Found

[./docs/advanced/air-gap/index.html]:
✗ [404] https://oras.land/cli/ | Failed: Network error: Not Found

[./docs/scanner/misconfiguration/custom/index.html]:
✗ [404] https://github.com/aquasecurity/defsec/blob/418759b4dc97af25f30f32e0bd365be7984003a1/pkg/types/sources.go) | Failed: Network error: Not Found
✗ [404] https://www.openpolicyagent.org/docs/latest/annotations/ | Failed: Network error: Not Found

[./getting-started/installation/index.html]:
✗ [404] https://archlinux.org/packages/community/x86_64/trivy/ | Failed: Network error: Not Found

[./docs/supply-chain/attestation/vuln/index.html]:
✗ [404] https://docs.sigstore.dev/cosign/key-generation | Failed: Network error: Not Found

[./tutorials/additional-resources/cks/index.html]:
✗ [403] https://jonathan18186.medium.com/certified-kubernetes-security-specialist-cks-preparation-part-7-supply-chain-security-9cf62c34cf6a | Failed: Network error: Forbidden
nikpivkin commented 1 year ago

There are also broken links on the terraform scanning tutorial page:

za commented 1 year ago

Hi there,

Are there any recent changes that causing those URL returns 404? Should we remove/update those broken links?