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.

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

Merged

Conversation

aerfio
Copy link
Contributor

@aerfio aerfio commented Feb 28, 2023

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:

  • they are part of documentation, duh
  • developers that use k8s.io/api structs in their own CRDs "inherit" those docs too
  • those links are visible in the output of kubectl explain, which is now broken, see example, rg used only to highlight the link

image

The 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 parts

Does this PR introduce a user-facing change?

NONE

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:


@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 28, 2023
@k8s-ci-robot
Copy link
Contributor

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 /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. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. area/code-generation kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/apps Categorizes an issue or PR as relevant to SIG Apps. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Feb 28, 2023
@k8s-triage-robot
Copy link

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.

@alculquicondor
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 28, 2023
Copy link
Member

@alculquicondor alculquicondor left a 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.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
// 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)

Copy link
Contributor Author

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 👍🏻

Copy link
Contributor Author

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.
is the same in 20+ places, but technically should be adjusted.

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:

  1. Update obsolete links to kubernetes.io/docs/user-guide in Go structs descriptions in kubelet packages #116115
  2. Update obsolete links to kubernetes.io/docs/user-guide in Go structs descriptions in corev1 packages #116113
  3. 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

@k8s-ci-robot k8s-ci-robot added the api-review Categorizes an issue or PR as actively needing an API review. label Feb 28, 2023
@cici37
Copy link
Contributor

cici37 commented Feb 28, 2023

/remove-sig api-machinery

@k8s-ci-robot k8s-ci-robot removed the sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. label Feb 28, 2023
@liggitt liggitt self-assigned this Mar 2, 2023
@liggitt liggitt added this to Changes requested in API Reviews Mar 2, 2023
@aerfio aerfio force-pushed the aerfio/update-broken-links-apps branch from 11b93c1 to d1877f5 Compare March 4, 2023 20:20
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 4, 2023
@liggitt
Copy link
Member

liggitt commented Mar 6, 2023

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 6, 2023
@liggitt liggitt moved this from Changes requested to API review completed, 1.27 in API Reviews Mar 6, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 4d33bc8059e9ecc982a7d4acd537afe1dfc6e71a

@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 6, 2023
@k8s-ci-robot k8s-ci-robot merged commit 3f20bcb into kubernetes:master Mar 6, 2023
@k8s-ci-robot k8s-ci-robot added this to the v1.27 milestone Mar 6, 2023
@aerfio aerfio deleted the aerfio/update-broken-links-apps branch March 6, 2023 17:37
@fedebongio
Copy link
Contributor

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Mar 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api-review Categorizes an issue or PR as actively needing an API review. approved Indicates a PR has been approved by an approver from all required OWNERS files. area/code-generation cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/apps Categorizes an issue or PR as relevant to SIG Apps. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
Status: API review completed, 1.27
Development

Successfully merging this pull request may close these issues.

None yet

7 participants