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

Update API doc to use the field name in description #113894

Merged
merged 4 commits into from Dec 9, 2022
Merged

Update API doc to use the field name in description #113894

merged 4 commits into from Dec 9, 2022

Conversation

ravi-nal
Copy link
Contributor

What type of PR is this?

/kind api-change
/kind documentation

What this PR does / why we need it:

This PR focuses on updating the documentation, for the following issue, to use the field name in description. No other documentation changes. The documentation is updated for the API groups - discovery and storage.

#113438

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

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/M Denotes a PR that changes 30-99 lines, ignoring generated files. 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. 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-triage Indicates an issue or PR lacks a `triage/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 Nov 14, 2022
@k8s-ci-robot
Copy link
Contributor

Hi @ravi-nal. 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 the needs-priority Indicates a PR lacks a `priority/foo` label and requires one. label Nov 14, 2022
@k8s-ci-robot k8s-ci-robot added sig/storage Categorizes an issue or PR as relevant to SIG Storage. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Nov 14, 2022
@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.

@jimangel
Copy link
Member

In @cici37's absence, I'm modeling the prow commands they provided in #113864. I'm not sure if I have the required permission to do so though... 🤞

/triage accepted
/priority important-longterm

@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. and 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 Nov 14, 2022
@jimangel
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 Nov 14, 2022
@ravi-nal
Copy link
Contributor Author

/test pull-kubernetes-update

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. area/code-generation sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 16, 2022
@ravi-nal
Copy link
Contributor Author

@xing-yang @wojtek-t @liggitt Please review when you get a chance.

liggitt
liggitt reviewed Nov 17, 2022
View reviewed changes
Copy link
Member

@liggitt liggitt left a comment

Choose a reason for hiding this comment

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

thanks for the PR, this is a good start. I noted a few fields that still needed updates, and storage/{v1alpha1,v1beta1}/types.go and discovery/v1/types.go need the same updates

staging/src/k8s.io/api/discovery/v1beta1/types.go Show resolved Hide resolved
staging/src/k8s.io/api/discovery/v1beta1/types.go Show resolved Hide resolved
staging/src/k8s.io/api/storage/v1/types.go Outdated
Provisioner string `json:"provisioner" protobuf:"bytes,2,opt,name=provisioner"`

// Parameters holds the parameters for the provisioner that should
// parameters holds the parameters for the provisioner that should
// create volumes of this storage class.
// +optional
Parameters map[string]string `json:"parameters,omitempty" protobuf:"bytes,3,rep,name=parameters"`

// Dynamically provisioned PersistentVolumes of this storage class are
Copy link
Member

Choose a reason for hiding this comment

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

something like

Suggested change
// Dynamically provisioned PersistentVolumes of this storage class are
// reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class

staging/src/k8s.io/api/storage/v1/types.go Show resolved Hide resolved
staging/src/k8s.io/api/storage/v1/types.go Show resolved Hide resolved
@liggitt liggitt mentioned this pull request Nov 17, 2022
Open
@ravi-nal
Copy link
Contributor Author

/test pull-kubernetes-update

@ravi-nal
Copy link
Contributor Author

/test pull-kubernetes-e2e-gce-100-performance

@ravi-nal ravi-nal requested review from liggitt and removed request for xing-yang and wojtek-t November 17, 2022 21:07
@ravi-nal
Copy link
Contributor Author

@liggitt Implemented all the suggestions. Pls. check again. Appreciate for the review.

liggitt
liggitt reviewed Nov 21, 2022
View reviewed changes
Copy link
Member

@liggitt liggitt left a comment

Choose a reason for hiding this comment

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

one question to storage review about a pre-existing comment that just got reformatted in this PR

lgtm otherwise

/lgtm
/approve
/milestone v1.27

staging/src/k8s.io/api/storage/v1/types.go
//
// This field is beta.
Copy link
Member

Choose a reason for hiding this comment

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

@pohly is this field still beta?

@k8s-ci-robot k8s-ci-robot added this to the v1.27 milestone Nov 21, 2022
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 21, 2022
@liggitt liggitt added this to API review completed, 1.27 in API Reviews Nov 21, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: liggitt, ravi-nal

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 Nov 21, 2022
@ravi-nal
Copy link
Contributor Author

one question to storage review about a pre-existing comment that just got reformatted in this PR

lgtm otherwise

/lgtm /approve /milestone v1.27

Thanks @liggitt. I will wait for the response for your question from @pohly

@k8s-ci-robot k8s-ci-robot merged commit 4650558 into kubernetes:master Dec 9, 2022
@k8s-ci-robot k8s-ci-robot modified the milestones: v1.27, v1.26 Dec 9, 2022
@liggitt liggitt modified the milestones: v1.26, v1.27 Dec 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@liggitt liggitt liggitt left review comments

Assignees

@liggitt liggitt

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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. 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/storage Categorizes an issue or PR as relevant to SIG Storage. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
API Reviews
Status: API review completed, 1.27
Milestone
v1.27
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@ravi-nal @k8s-ci-robot @k8s-triage-robot @jimangel @liggitt