-
Notifications
You must be signed in to change notification settings - Fork 112
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
A lot of broken links in metal3-docs #328
Comments
/good-first-issue |
@tuminoid: Please ensure the request meets the requirements listed here. If this request no longer meets these requirements, the label can be removed 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. |
@tuminoid thanks for this! |
@elfosardo @tuminoid |
/assign @SafeEHA |
@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. 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. |
Hello @elfosardo @tuminoid |
Assigned! |
I am also willing to work on the issue @tuminoid @elfosardo cc: |
Hello @dhellmann |
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 |
Hello @dhellmann |
Hi @kashifest https://github.com/metal3-io/baremetal-operator/blob/main/deploy/crds/metal3.io_baremetalhosts_crd.yaml on this page re-inspection API proposal and CAPI MachineHealthCheck on this page |
Hi @fmuyassarov Hello @Hellcatlk Hello @Arvinderpal |
Hello @fmuyassarov @Hellcatlk @dhellmann @Arvinderpal @kashifest |
I will provide the links soon. |
Hello Everyone |
It has been a month since last update. How is this progressing? |
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 |
CAPI machine healthcheck - https://cluster-api.sigs.k8s.io/developer/architecture/controllers/machine-health-check.html |
Remediation proposal- https://github.com/metal3-io/metal3-docs/blob/main/design/cluster-api-provider-metal3/capm3-remediation-controller-proposal.md |
Issues go stale after 90d of inactivity. If this issue is safe to close now please do so with /lifecycle stale |
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 |
/remove-lifecycle stale |
@SafeEHA do you want to work on this still? If not, I'm going to bring it to our contrib-fest session at KubeCon 🙂 |
Yeah with your suggestions I should make some progress, I'll have updates soon |
So far I fixed 3 out of the 6 broken links I listed earlier on this PR #387 thanks to pointers from @lentzi90 Also, for this - Link on this page, would we take it out completely or replace with some other resource since it no longer exists? |
The GitHub Search Query works as it should but we may have to configure the link checker to understand it. Ignore it for now. As mentioned, check the history for the page. When was it created? Then go to metal3-dev-env commits and select commits from around the same time. Pick a commit and click "Browse the repository at this time" ( Check what the content is. If we have something similar somewhere else, we can link to that. Otherwise just link to the the CRs at this commit.
It is already removed. You don't have to do anything. |
Apologies for responding late, had a busy week cc: @lentzi90 |
You can link directly to this: https://github.com/metal3-io/metal3-dev-env/tree/b5a53ecf9576c6deab81f692733782d4c5e8091a/crs |
Issues go stale after 90d of inactivity. If this issue is safe to close now please do so with /lifecycle stale |
/remove-lifecycle stale I'm going to split this issue up, with the fresh data, as this is too massive to anyone to work on apparently. |
Created 8 issues linked above for the dead links. These are real issues. In additiion, there are plenty of internal false positives, where the link checker checks for absolute links and does not understand internal, generated links. ( This issue is now done. Thanks for everyone who contributed so far. /close |
@tuminoid: Closing this issue. 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. |
This is the current list of broken links in this repository that need to be fixed.
After these are fixed, we can merge #322 to add broken link checker to keep repository clean from broken links.
The text was updated successfully, but these errors were encountered: