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

Ingress API: rework the ingressClassName API documentation #109293

Merged
merged 8 commits into from
Jun 9, 2022
Merged

Ingress API: rework the ingressClassName API documentation #109293

merged 8 commits into from
Jun 9, 2022

Conversation

iamNoah1
Copy link
Contributor

@iamNoah1 iamNoah1 commented Apr 4, 2022

What type of PR is this?

/kind documentation
/sig network

What this PR does / why we need it:

This PR is following up #107675 and adds a suggestion for improving the API docs.

Does this PR introduce a user-facing change?

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. sig/network Categorizes an issue or PR as relevant to SIG Network. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. 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. labels Apr 4, 2022
@k8s-ci-robot k8s-ci-robot added the kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API label Apr 4, 2022
@iamNoah1
Copy link
Contributor Author

iamNoah1 commented Apr 4, 2022 •
edited
Loading

cc @maelvls

@iamNoah1 iamNoah1 mentioned this pull request Apr 4, 2022
Closed
@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.

@k8s-ci-robot k8s-ci-robot added area/code-generation sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. labels Apr 5, 2022
@cici37
Copy link
Contributor

cici37 commented Apr 5, 2022

/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 Apr 5, 2022
@iamNoah1
Copy link
Contributor Author

iamNoah1 commented Apr 6, 2022

cc @rikatz @strongjz @tao12345666333 @longwuyuan

@rikatz
Copy link
Contributor

rikatz commented Apr 8, 2022

/cc @rikatz @robscott
/assign @rikatz @robscott

@robscott
Copy link
Member

robscott commented Apr 9, 2022

This is a great improvement, thanks @iamNoah1. Open to other feedback, but this LGTM as is.

/triage accepted
/priority important-longterm
/assign @thockin

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. labels Apr 9, 2022
@k8s-ci-robot k8s-ci-robot removed 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. labels Apr 9, 2022
@iamNoah1
Copy link
Contributor Author

iamNoah1 commented Apr 9, 2022

This is a great improvement, thanks @iamNoah1. Open to other feedback, but this LGTM as is.

/triage accepted /priority important-longterm /assign @thockin

Thanks, @robscott, credits definitely go to @maelvls who initiated the improvement.

@k8s-ci-robot k8s-ci-robot added the sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. label Apr 9, 2022
@tao12345666333
Copy link
Member

/test pull-kubernetes-e2e-kind-ipv6

@iamNoah1
Copy link
Contributor Author

@robscott @thockin is there anything I could do to drive this forward?

maelvls
maelvls approved these changes Apr 23, 2022
View reviewed changes
Copy link

@maelvls maelvls left a comment

Choose a reason for hiding this comment

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

This is a great improvement over the lengthy change I had proposed in #107675. Thank you so much @iamNoah1 for taking over!!!

staging/src/k8s.io/api/networking/v1/types.go Outdated Show resolved Hide resolved
@iamNoah1 iamNoah1 requested review from sftim and thockin April 26, 2022 11:14
@maelvls maelvls mentioned this pull request May 5, 2022
Closed
9 tasks
thockin
thockin reviewed May 6, 2022
View reviewed changes
staging/src/k8s.io/api/networking/v1/types.go Outdated
@@ -305,13 +305,13 @@ type IngressSpec struct {
// IngressClassName is the name of an IngressClass cluster resource. Ingress
// controller implementations use this field to know whether they should be
// serving this Ingress resource, by a transitive connection
// (controller -> IngressClass -> Ingress resource). Although the
// (controller → IngressClass → Ingress resource). Although the
Copy link
Member

Choose a reason for hiding this comment

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

I know it's allowed, but I'd prefer to keep the comments ASCII if we can

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sftim requested to use those, but I don't really mind to change it again ^^

Copy link
Contributor

Choose a reason for hiding this comment

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

It'd be good to codify this sort of thing in review guidelines and perhaps even CI tests.

For the rendered API docs, arrows are better than ASCII art. In source code, maybe we're worried about compatibility with older OSs?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sftim, @thockin I understand that this topic is something that should be clarified long term. What can I do to get this PR merged?

Copy link
Contributor

Choose a reason for hiding this comment

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

For the arrows here, I'm fine with either approach. I hadn't spotted the ASCII-comments-only restriction.

@robscott
Copy link
Member

robscott commented Jun 9, 2022

Thanks @iamNoah1!

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 9, 2022
thockin
thockin reviewed Jun 9, 2022
View reviewed changes
Copy link
Member

@thockin thockin left a comment

Choose a reason for hiding this comment

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

Thanks!

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: iamNoah1, maelvls, thockin

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 Jun 9, 2022
@k8s-ci-robot k8s-ci-robot merged commit f80d17e into kubernetes:master Jun 9, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.25 milestone Jun 9, 2022
@iamNoah1
Copy link
Contributor Author

wuhuu thanks @robscott, @thockin

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thockin thockin thockin left review comments

@szuecs szuecs szuecs left review comments

@maelvls maelvls maelvls approved these changes

@danwinship danwinship Awaiting requested review from danwinship

@rikatz rikatz Awaiting requested review from rikatz

@robscott robscott Awaiting requested review from robscott

@sftim sftim Awaiting requested review from sftim

Assignees

@robscott robscott

@thockin thockin

@rikatz rikatz

Labels
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/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. 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/network Categorizes an issue or PR as relevant to SIG Network. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
v1.25
Development

Successfully merging this pull request may close these issues.