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
Update obsolete links to kubernetes.io/docs/user-guide in Go structs descriptions in apps packages #116124
Update obsolete links to kubernetes.io/docs/user-guide in Go structs descriptions in apps packages #116124
Conversation
Hi @aerfio. Thanks for your PR. I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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 PR may require API review. If so, when the changes are ready, complete the pre-review checklist and request an API review. Status of requested reviews is tracked in the API Review project. |
/ok-to-test |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/label api-review
@@ -41,7 +41,7 @@ type ScaleStatus struct { | |||
// actual number of observed instances of the scaled object. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
// actual number of observed instances of the scaled object. | |
// replicas is the number of observed instances of the scaled object. |
If you find other instances like this, please fix. The first word should match the name of the field (in lowerCamelCase
)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, I'll fix it in the next week 👍🏻
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm I've updated most of the prefixes in that file, but this review suggestion seems to enlarge this PR several times 😢 I've left some comment like they were because they are the same throughout the whole codebase, e.g
// Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
Should I fix also the v1beta2 file or just revert the d1877f5 and introduce only fixes to the links? I've 3 other PRs where I only fix the links:
- Update obsolete links to kubernetes.io/docs/user-guide in Go structs descriptions in kubelet packages #116115
- Update obsolete links to kubernetes.io/docs/user-guide in Go structs descriptions in corev1 packages #116113
- Update obsolete links to kubernetes.io/docs/user-guide in Go structs descriptions in autoscaling packages #116109
and 2 of them got LGTM'd.
I'm also fine with fixing those comments but I'd like to know the scope of this :D
/remove-sig api-machinery |
11b93c1
to
d1877f5
Compare
/lgtm |
LGTM label has been added. Git tree hash: 4d33bc8059e9ecc982a7d4acd537afe1dfc6e71a
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: aerfio, liggitt The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
/triage accepted |
What type of PR is this?
/kind cleanup
/kind documentation
What this PR does / why we need it:
Partly supersedes #116107
This PR updates the links to http://kubernetes.io/docs/user-guide in various resources/structs' descriptions which are no longer valid, to their new equivalents. Those descriptions are useful because:
kubectl explain
, which is now broken, see example,rg
used only to highlight the linkThe issue was found when we were validating the links in the documentation generated from CRD yamls (generated via controller-gen, and I suspect that a lot of projects generate those docs too, see
All of the links have been also updated to use https instead of http.
Those links used to work, but the kubernetes/website#39143 removed those redirects.
Which issue(s) this PR fixes:
Special notes for your reviewer:
I used
make update
to regenerate the .proto and openapi files, I hope that's enough. If this PR is too big I can split it into smaller partsDoes this PR introduce a user-facing change?
Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.: