metal3-docs: A lot of broken links in metal3-docs
This is the current list of broken links in this repository that need to be fixed.
+ find . -name '*.md' -not -path './node_modules/*' -exec markdown-link-check '{}' --config .markdownlinkcheck.json -q ';'
| + set +x
| =========================> MARKDOWN LINK CHECK <=========================
|
| FILE: ./docs/presentations/README.md
|
| 4 links checked.
|
| FILE: ./docs/README.md
|
| 2 links checked.
|
| FILE: ./docs/prerequisites.md
|
| 0 links checked.
|
| FILE: ./docs/user-guide/README.md
|
| 5 links checked.
|
| FILE: ./docs/user-guide/src/introduction.md
|
| 7 links checked.
|
| FILE: ./docs/user-guide/src/ipam/ipam_installation.md
|
| 4 links checked.
|
| FILE: ./docs/user-guide/src/ipam/introduction.md
|
| 1 links checked.
|
| FILE: ./docs/user-guide/src/version_support.md
|
| 1 links checked.
|
| FILE: ./docs/user-guide/src/security_policy.md
|
| 4 links checked.
|
| FILE: ./docs/user-guide/src/flake/introduction.md
|
| 0 links checked.
|
| FILE: ./docs/user-guide/src/flake/bmh_stuck.md
| [✖] https://opendev.org/openstack/ironic/src/commit/eeeaa274cfc7ebee52beaed97571e2f87127f2dd/ironic/db/sqlalchemy/api.py#L2056
|
| 3 links checked.
|
| ERROR: 1 dead links found!
| [✖] https://opendev.org/openstack/ironic/src/commit/eeeaa274cfc7ebee52beaed97571e2f87127f2dd/ironic/db/sqlalchemy/api.py#L2056 → Status: 0
|
| FILE: ./docs/user-guide/src/flake/calico_manifest_download.md
|
| 1 links checked.
|
| FILE: ./docs/user-guide/src/flake/floating_ip_error.md
|
| 0 links checked.
|
| FILE: ./docs/user-guide/src/flake/prow.md
|
| 1 links checked.
|
| FILE: ./docs/user-guide/src/flake/nordix_timeout.md
|
| 3 links checked.
|
| FILE: ./docs/user-guide/src/SUMMARY.md
|
| 31 links checked.
|
| FILE: ./docs/user-guide/src/ironic/ironic_installation.md
|
| 4 links checked.
|
| FILE: ./docs/user-guide/src/ironic/introduction.md
|
| 9 links checked.
|
| FILE: ./docs/user-guide/src/ironic/ironic_variables.md
|
| 0 links checked.
|
| FILE: ./docs/user-guide/src/ironic/ironic-container-images.md
|
| 5 links checked.
|
| FILE: ./docs/user-guide/src/ironic/ironic-python-agent.md
|
| 5 links checked.
|
| FILE: ./docs/user-guide/src/capm3/node_reuse.md
|
| 2 links checked.
|
| FILE: ./docs/user-guide/src/capm3/introduction.md
|
| 14 links checked.
|
| FILE: ./docs/user-guide/src/capm3/remediaton.md
|
| 3 links checked.
|
| FILE: ./docs/user-guide/src/capm3/installation_guide.md
| [✖] TODO
|
| 4 links checked.
|
| ERROR: 1 dead links found!
| [✖] TODO → Status: 400
|
| FILE: ./docs/user-guide/src/capm3/automated_cleaning.md
|
| 2 links checked.
|
| FILE: ./docs/user-guide/src/capm3/pivoting.md
|
| 4 links checked.
|
| FILE: ./docs/user-guide/src/bmo/automatic_secure_boot.md
|
| 2 links checked.
|
| FILE: ./docs/user-guide/src/bmo/reboot_annotation.md
|
| 2 links checked.
|
| FILE: ./docs/user-guide/src/bmo/detached_annotation.md
|
| 2 links checked.
|
| FILE: ./docs/user-guide/src/bmo/introduction.md
|
| 2 links checked.
|
| FILE: ./docs/user-guide/src/bmo/status_annotation.md
|
| 1 links checked.
|
| FILE: ./docs/user-guide/src/bmo/automated_cleaning.md
|
| 3 links checked.
|
| FILE: ./docs/user-guide/src/bmo/external_inspection.md
|
| 1 links checked.
|
| FILE: ./docs/user-guide/src/bmo/live-iso.md
|
| 2 links checked.
|
| FILE: ./docs/user-guide/src/bmo/inspect_annotation.md
|
| 1 links checked.
|
| FILE: ./design/_template.md
| [✖] /designs/_template.md
|
| 2 links checked.
|
| ERROR: 1 dead links found!
| [✖] /designs/_template.md → Status: 400
|
| FILE: ./design/baremetal-operator/host-config-drive.md
|
| 3 links checked.
|
| FILE: ./design/baremetal-operator/managing-provisioning-dependencies.md
|
| 1 links checked.
|
| FILE: ./design/baremetal-operator/annotation-for-power-cycling-and-deleting-failed-nodes.md
|
| 5 links checked.
|
| FILE: ./design/baremetal-operator/bmo-part-of-capm3.md
|
| 1 links checked.
|
| FILE: ./design/baremetal-operator/reboot-interface.md
|
| 0 links checked.
|
| FILE: ./design/baremetal-operator/bmc-events.md
| [✖] https://www.dell.com/support/manuals/en-jm/idrac9-lifecycle-controller-v4.x-series/idrac9_4.00.00.00_redfishapiguide_pub/temperature?guid=guid-5a798111-407b-485d-b6fb-7d6e367d4ad4&lang=en-us
|
| 7 links checked.
|
| ERROR: 1 dead links found!
| [✖] https://www.dell.com/support/manuals/en-jm/idrac9-lifecycle-controller-v4.x-series/idrac9_4.00.00.00_redfishapiguide_pub/temperature?guid=guid-5a798111-407b-485d-b6fb-7d6e367d4ad4&lang=en-us → Status: 403
|
| FILE: ./design/baremetal-operator/explicit-boot-mode.md
|
| 4 links checked.
|
| FILE: ./design/baremetal-operator/bulk-set-bios-config.md
|
| 7 links checked.
|
| FILE: ./design/baremetal-operator/sub-states.md
|
| 2 links checked.
|
| FILE: ./design/baremetal-operator/hardwaredata_crd.md
|
| 13 links checked.
|
| FILE: ./design/baremetal-operator/bmc-address.md
|
| 1 links checked.
|
| FILE: ./design/baremetal-operator/raid-disk-controller.md
|
| 0 links checked.
|
| FILE: ./design/baremetal-operator/bmh_live_iso.md
|
| 6 links checked.
|
| FILE: ./design/baremetal-operator/deploy-steps.md
|
| 6 links checked.
|
| FILE: ./design/baremetal-operator/kubebuilder-migration.md
| [✖] https://sdk.operatorframework.io/docs/building-operators/golang/project_migration_guide/
|
| 16 links checked.
|
| ERROR: 1 dead links found!
| [✖] https://sdk.operatorframework.io/docs/building-operators/golang/project_migration_guide/ → Status: 404
|
| FILE: ./design/baremetal-operator/limit-hosts-provisioning.md
|
| 2 links checked.
|
| FILE: ./design/baremetal-operator/external-introspection.md
|
| 6 links checked.
|
| FILE: ./design/baremetal-operator/how-ironic-works.md
|
| 6 links checked.
|
| FILE: ./design/baremetal-operator/secure-boot.md
|
| 2 links checked.
|
| FILE: ./design/baremetal-operator/image-builder-integration.md
|
| 3 links checked.
|
| FILE: ./design/baremetal-operator/user-defined-root-device-hints.md
|
| 2 links checked.
|
| FILE: ./design/baremetal-operator/remove-host.md
|
| 0 links checked.
|
| FILE: ./design/baremetal-operator/unmanaged-state.md
|
| 2 links checked.
|
| FILE: ./design/baremetal-operator/raid-api.md
|
| 2 links checked.
|
| FILE: ./design/baremetal-operator/inspection-api.md
|
| 2 links checked.
|
| FILE: ./design/baremetal-operator/implicit-boot-mode.md
| [✖] https://github.com/metal3-io/baremetal-operator/blob/main/pkg/bmc/access.go#L27
|
| 8 links checked.
|
| ERROR: 1 dead links found!
| [✖] https://github.com/metal3-io/baremetal-operator/blob/main/pkg/bmc/access.go#L27 → Status: 404
|
| FILE: ./design/baremetal-operator/hardware-status.md
|
| 6 links checked.
|
| FILE: ./design/baremetal-operator/detached-annotation.md
|
| 4 links checked.
|
| FILE: ./design/baremetal-operator/bios-config.md
|
| 3 links checked.
|
| FILE: ./design/helm-charts/single-pod-helm-chart.md
|
| 0 links checked.
|
| FILE: ./design/image-ownership.md
|
| 0 links checked.
|
| FILE: ./design/api-design-principles.md
|
| 1 links checked.
|
| FILE: ./design/physical-network-api-prototype.md
|
| 8 links checked.
|
| FILE: ./design/ip-address-manager/ip-address-management-for-networkdata.md
|
| 23 links checked.
|
| FILE: ./design/nodes-machines-and-hosts.md
| [✖] https://kubernetes-sigs.github.io/cluster-api/common_code/machine_controller.html
|
| 8 links checked.
|
| ERROR: 1 dead links found!
| [✖] https://kubernetes-sigs.github.io/cluster-api/common_code/machine_controller.html → Status: 404
|
| FILE: ./design/metadata-handling.md
|
| 3 links checked.
|
| FILE: ./design/fd-support-kcp.md
|
| 7 links checked.
|
| FILE: ./design/ironic_authentication.md
|
| 4 links checked.
|
| FILE: ./design/bare-metal-style-guide.md
|
| 0 links checked.
|
| FILE: ./design/sync-labels-bmh-to-node.md
| [✖] https://github.com/kubernetes/enhancements/blob/master/keps/sig-auth/0000-20170814-bounding-self-labeling-kubelets.md
|
| 3 links checked.
|
| ERROR: 1 dead links found!
| [✖] https://github.com/kubernetes/enhancements/blob/master/keps/sig-auth/0000-20170814-bounding-self-labeling-kubelets.md → Status: 404
|
| FILE: ./design/use-ironic.md
|
| 4 links checked.
|
| FILE: ./design/ironic-debuggability-improvement.md
| [✖] https://github.com/metal3-io/baremetal-operator/blob/main/ironic-deployment/ironic/ironic.yaml
|
| 5 links checked.
|
| ERROR: 1 dead links found!
| [✖] https://github.com/metal3-io/baremetal-operator/blob/main/ironic-deployment/ironic/ironic.yaml → Status: 404
|
| FILE: ./design/hardware-classification-controller/expected-hardware-configuration-validation.md
| [✖] https://github.com/metal3-io/baremetal-operator/blob/main/deploy/crds/metal3.io_baremetalhosts_crd.yaml
|
| 4 links checked.
|
| ERROR: 1 dead links found!
| [✖] https://github.com/metal3-io/baremetal-operator/blob/main/deploy/crds/metal3.io_baremetalhosts_crd.yaml → Status: 404
|
| FILE: ./design/hardware-classification-controller/support-for-new-parameters-hwcc-DiskAndNIC.md
|
| 4 links checked.
|
| FILE: ./design/hardware-classification-controller/support-for-error-count-parameter-hwcc.md
|
| 3 links checked.
|
| FILE: ./design/hardware-classification-controller/support-for-new-parameters-hwcc.md
|
| 4 links checked.
|
| FILE: ./design/reproducible-metal3-dev-env.md
|
| 2 links checked.
|
| FILE: ./design/cluster-api-provider-metal3/node_reuse.md
| [✖] https://github.com/metal3-io/metal3-docs/blob/main/design/capm3-remediation-controller-proposal.md
|
| 2 links checked.
|
| ERROR: 1 dead links found!
| [✖] https://github.com/metal3-io/metal3-docs/blob/main/design/capm3-remediation-controller-proposal.md → Status: 404
|
| FILE: ./design/cluster-api-provider-metal3/capm3-remediation-controller-proposal.md
| [✖] https://cluster-api.sigs.k8s.io/tasks/healthcheck.html
| [✖] https://github.com/metal3-io/metal3-docs/blob/main/design/baremetal-operator/re-introspection-interface.md
|
| 5 links checked.
|
| ERROR: 2 dead links found!
| [✖] https://cluster-api.sigs.k8s.io/tasks/healthcheck.html → Status: 404
| [✖] https://github.com/metal3-io/metal3-docs/blob/main/design/baremetal-operator/re-introspection-interface.md → Status: 404
|
| FILE: ./design/cluster-api-provider-metal3/capm3-remediation-controller-improvement-proposal.md
|
| 7 links checked.
|
| FILE: ./design/cluster-api-provider-metal3/allow_disabling_node_disk_cleaning.md
|
| 5 links checked.
|
| FILE: ./design/community/foundation-proposal.md
| [✖] https://github.com/cncf/toc/blob/master/process/project_proposals.adoc
| [✖] https://github.com/cncf/toc/blob/master/process/graduation_criteria.adoc
|
| 8 links checked.
|
| ERROR: 2 dead links found!
| [✖] https://github.com/cncf/toc/blob/master/process/project_proposals.adoc → Status: 404
| [✖] https://github.com/cncf/toc/blob/master/process/graduation_criteria.adoc → Status: 404
|
| FILE: ./design/community/book-proposal.md
|
| 5 links checked.
|
| FILE: ./ADOPTERS.md
| [✖] https://www.ericsson.com/en/portfolio/digital-services/cloud-infrastructure/cloud-container-distribution
|
| 4 links checked.
|
| ERROR: 1 dead links found!
| [✖] https://www.ericsson.com/en/portfolio/digital-services/cloud-infrastructure/cloud-container-distribution → Status: 403
|
| FILE: ./processes/managing-reviewers.md
|
| 3 links checked.
|
| FILE: ./processes/reviewer-permissions-migration.md
|
| 2 links checked.
|
| FILE: ./processes/roadmap.md
|
| 1 links checked.
|
| FILE: ./processes/triage.md
| [✖] https://github.com/issues?utf8=%E2%9C%93&q=archived%3Afalse+user%3Ametal3-io+no%3Alabel+is%3Aissue+sort%3Acreated-asc+is%3Aopen
| [✖] https://github.com/issues?utf8=%E2%9C%93&q=archived%3Afalse+user%3Ametal3-io+is%3Aissue+sort%3Acreated-asc+is%3Aopen+label%3Apriority%2Fawaiting-more-evidence
| [✖] https://github.com/issues?q=archived%3Afalse+user%3Ametal3-io+is%3Aissue+sort%3Acreated-asc+is%3Aopen+label%3Alifecycle%2Fstale
|
| 3 links checked.
|
| ERROR: 3 dead links found!
| [✖] https://github.com/issues?utf8=%E2%9C%93&q=archived%3Afalse+user%3Ametal3-io+no%3Alabel+is%3Aissue+sort%3Acreated-asc+is%3Aopen → Status: 404
| [✖] https://github.com/issues?utf8=%E2%9C%93&q=archived%3Afalse+user%3Ametal3-io+is%3Aissue+sort%3Acreated-asc+is%3Aopen+label%3Apriority%2Fawaiting-more-evidence → Status: 404
| [✖] https://github.com/issues?q=archived%3Afalse+user%3Ametal3-io+is%3Aissue+sort%3Acreated-asc+is%3Aopen+label%3Alifecycle%2Fstale → Status: 404
|
| FILE: ./CONTRIBUTING.md
|
| 2 links checked.
|
| FILE: ./CODE_OF_CONDUCT.md
|
| 5 links checked.
|
| FILE: ./README.md
|
| 11 links checked.
|
| FILE: ./maintainers/README.md
|
| 0 links checked.
|
| FILE: ./crs_reference.md
| [✖] https://github.com/metal3-io/metal3-dev-env/tree/master/crs
|
| 3 links checked.
|
| ERROR: 1 dead links found!
| [✖] https://github.com/metal3-io/metal3-dev-env/tree/master/crs → Status: 404
|
After these are fixed, we can merge https://github.com/metal3-io/metal3-docs/pull/322 to add broken link checker to keep repository clean from broken links.
About this issue
- Original URL
- State: open
- Created a year ago
- Comments: 48 (46 by maintainers)
Assigned!
You can link directly to this: https://github.com/metal3-io/metal3-dev-env/tree/b5a53ecf9576c6deab81f692733782d4c5e8091a/crs That is what they meant to link to originally.
So far I fixed 3 out of the 6 broken links I listed earlier on this PR #387 thanks to pointers from @lentzi90 The other 3 however are still pending… This - GitHub Search Query under New issue triage and this - CRs on this page
Also, for this - Link on this page, would we take it out completely or replace with some other resource since it no longer exists?
Yeah with your suggestions I should make some progress, I’ll have updates soon
Adding some suggestions and hints inline
I think we should link here
Find some kind of definition or API reference here and link to it.
Looks to me like this link is working.
Check when this page in the docs was first written and go back in history to the same point in metal3-dev-env. Check what the content was back then and either link to that point in time or find some new material that matches.
The page no longer exists. No change needed.
It has moved here
You need to push the branches to your fork, and then create PR. Directly pushing is not allowed for anyone.
@tuminoid I apologize for how long this has taken, I am still quite new here and I’ve been trying to get familiar with everything I corrected the links for the first 2 out of the 3 broken links in the first PR I created, the others have been a bit more complicated to decipher but i assure you I’m doing my best
Remediation proposal- https://github.com/metal3-io/metal3-docs/blob/main/design/cluster-api-provider-metal3/capm3-remediation-controller-proposal.md
CAPI machine healthcheck - https://cluster-api.sigs.k8s.io/developer/architecture/controllers/machine-health-check.html
the correct link for the CRD is https://github.com/metal3-io/baremetal-operator/blob/main/config/crd/bases/metal3.io_baremetalhosts.yaml , please ping the persons who have written the proposals originally if any more updates are needed
I will provide the links soon.
It looks like that template is trying to link to itself and I either typoed “design” as “designs” or things were moved later. So I think if you change
https://github.com/metal3-io/metal3-docs/blob/main/designs/_template.md
tohttps://github.com/metal3-io/metal3-docs/blob/main/design/_template.md
it will work.Hello @elfosardo @tuminoid I would begin working on this as soon as possible Thanks
In GitHub, you can’t assign non-members or non-contributors that have not previously commented in an issue/PR. So please @SafeEHA comment here and we can assign this to you.
@elfosardo: GitHub didn’t allow me to assign the following users: SafeEHA.
Note that only metal3-io members with read permissions, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time. For more information please see the contributor guide
In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.