metal3-io / metal3-docs

Architecture documentation that describes the components being built under Metal³.
http://metal3.io
Apache License 2.0
263 stars 111 forks source link

fixed broken link reference to CRs #447

Open chibuikeIg opened 2 weeks ago

chibuikeIg commented 2 weeks ago

Which problem is this PR solving?

Closes issue: Fix dead links at crs_reference.md #446 Fixes: #446

Description of the changes

Changed from https://github.com/metal3-io/metal3-dev-env/tree/master/crs to https://github.com/metal3-io/metal3-dev-env/tree/b5a53ecf9576c6deab81f692733782d4c5e8091a/crs

How was this change tested?

Ensured the link works both on Browser and when clicked on the Doc.

metal3-io-bot commented 2 weeks ago

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Once this PR has been reviewed and has the lgtm label, please assign dtantsur for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files: - **[OWNERS](https://github.com/metal3-io/metal3-docs/blob/main/OWNERS)** Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
metal3-io-bot commented 2 weeks ago

Hi @chibuikeIg. Thanks for your PR.

I'm waiting for a metal3-io member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
tuminoid commented 2 weeks ago

Thanks for the PR! Please fix the DCO (sign-off the commit) and repush.

/ok-to-test /cc @kashifest

PTAL if the linking the last version of the CRS is the right link to replace the dead link, or was the content actually migrated elsewhere. /hold

dtantsur commented 5 days ago

PTAL if the linking the last version of the CRS is the right link to replace the dead link, or was the content actually migrated elsewhere.

I think it was migrated under the base subdirectory, and indeed we should link to the most recent version.

kashifest commented 5 days ago

I think this whole crs_reference.md file is obsolete, its still pointing to cluster-api-provider-baremetal! and v1a2 and v1a3 of apis, the crs are non existent in dev-env since I believe

tuminoid commented 5 days ago

We have two contradicting opinions it seems. It is the only file in the root of the repo and indeed looks obsolete, so insttead of fixing the link we could delete the whole file? @dtantsur @kashifest