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.

Sign up for GitHub

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

Jump to bottom

fixed broken links on design dir #387

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fixed broken links on design dir #387

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
892808e
update to nodes-machines-and-hosts.md
SafeEHA Mar 9, 2024
6e027da
CRs url fix
SafeEHA Mar 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion crs_reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ they reference to each other. To see the example CRs check
## Environment Variables

The user is required to set the following environment variables before applying
the [CRs](https://github.com/metal3-io/metal3-dev-env/tree/master/crs)
the [CRs](https://github.com/metal3-io/metal3-dev-env/tree/b5a53ecf9576c6deab81f692733782d4c5e8091a/crs)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest dropping the link completely if we don't have an up-to-date version.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, do we rephrase the sentence also, since it points to the link?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly, if we want up to date here we would need to completely rewrite the page or delete it.
I'm happy for now with linking to the old version. That way we can hopefully enable the link checker.
The whole page could eventually be replaced by #402 I think

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To confirm, are there any changes left to make? cause I believe the broken links highlighted in #328 have all been addressed, I would be happy to take a final look...in the meantime please help review code changes and merge this PR. Also, I would love to be assigned #402 if that's ok @lentzi90 I see it is a new issue

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is all good from my side, so I'll approve. Let's see what @dtantsur has to say then before it is merged.
Go ahead and work on #402! Thank you for the contributions! 😊


```console
CLUSTER_NAME
Expand Down
2 changes: 1 addition & 1 deletion design/baremetal-operator/kubebuilder-migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ all metal3 repositories.
- The [v1alpha2 API
migration](https://github.com/metal3-io/metal3-docs/pull/101)
proposal.
- [operator-sdk 1.0 migration guide](https://sdk.operatorframework.io/docs/building-operators/golang/project_migration_guide/)
- [operator-sdk 1.0 migration guide](https://sdk.operatorframework.io/docs/building-operators/golang/migration/)
- [migration implementation pull request](https://github.com/metal3-io/baremetal-operator/pull/655)
- updates to kustomize deployment files and CI fixes:
- <https://github.com/metal3-io/baremetal-operator/pull/672>
Expand Down
2 changes: 1 addition & 1 deletion design/nodes-machines-and-hosts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ such as draining the node for maintenance. The definition of Node is
owned by the Kubernetes core, and offers few opportunities to attach
custom data.

[Machine](https://kubernetes-sigs.github.io/cluster-api/common_code/machine_controller.html)
[Machine](https://cluster-api.sigs.k8s.io/user/concepts#machine)
objects represent a *request* for an instance of kubelet. A parallel
design is the persistent volume claim and persistent volume in the
storage APIs. The Machine CRD is owned by the cluster-api SIG. Machine
Expand Down
2 changes: 1 addition & 1 deletion design/sync-labels-bmh-to-node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ this label.

There is also a security vulnerability associated with kubelet's ability to
self-label the Node object. This has been
[addressed](https://github.com/kubernetes/enhancements/blob/master/keps/sig-auth/0000-20170814-bounding-self-labeling-kubelets.md).
[addressed](https://github.com/kubernetes/enhancements/blob/master/keps/sig-auth/279-limit-node-access/README.md).
However, as a consequence, BMH labels that fall within the *.kubernetes.io/*
space cannot be specified via kubelet's `--node-labels` flag.

Expand Down