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 documenting a feature for a release doc #25199

Merged
merged 1 commit into from
Dec 15, 2020
Merged

Update documenting a feature for a release doc #25199

merged 1 commit into from
Dec 15, 2020

Conversation

annajung
Copy link
Contributor

Signed-off-by: Anna Jung (VMware) [email protected]

  • Update the placeholder PR instruction to utilize the draft PR functionality of github.
  • Remove instruction on using the prow command /milestone as it does not notify the docs team. Instead, specified that docs PR link should be linked in the enhancement
  • Add a step to change the PR from draft to Ready for Review state
  • Move the updating the feature gate to "PR Ready for Review" section and add instruction on how to document alpha/beta/graduated feature gates

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 23, 2020
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language size/S Denotes a PR that changes 10-29 lines, ignoring generated files. sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Nov 23, 2020
@netlify
Copy link

netlify bot commented Nov 23, 2020 •
edited
Loading

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 1890273

https://deploy-preview-25199--kubernetes-io-master-staging.netlify.app

@annajung
Copy link
Contributor Author

Page preview: https://deploy-preview-25199--kubernetes-io-master-staging.netlify.app/docs/contribute/new-content/new-features

tengqm
tengqm reviewed Nov 26, 2020
View reviewed changes
content/en/docs/contribute/new-content/new-features.md
@@ -95,14 +95,14 @@ deadlines.

### Open a placeholder PR

1. Open a pull request against the
1. Open a **draft** pull request against the
Copy link
Contributor

Choose a reason for hiding this comment

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

"draft" here looks like a relative term to "ready for review" below, if I'm understanding this correctly.

Please be specific how to mark a PR as a "draft". Do you mean prefixing the PR title with "WIP -" or something?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's a stage of a pull request that is offered by Github. I can see that it may be not clear, so I added steps on how to mark a pull request as "draft" and "ready for review" in the corresponding sections. Could you take a look again? Does this make more sense?

@annajung annajung force-pushed the modify-release-doc-instruction branch from 8cbb61c to 1890273 Compare December 1, 2020 01:17
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Dec 1, 2020
@annajung annajung requested a review from tengqm December 1, 2020 15:43
tengqm
tengqm reviewed Dec 10, 2020
View reviewed changes
content/en/docs/contribute/new-content/new-features.md
commit that you will amend later.
commit that you will amend later. To create a draft pull request, use the
Create Pull Request drop-down and select **Create Draft Pull Request**,
then click **Draft Pull Request**.
Copy link
Contributor

Choose a reason for hiding this comment

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

Okay, now I see. Draft Pull Request is something one can raise from Web UI. If I'm opening a PR from git command line, there is actually no difference between a "draft" and a "formal" one, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, that's correct. This is specific to Github not git.
It should not impact the people using the git command line to make a pull request, they'll have to use the UI to set it to draft if needed.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for the clarification. @annajung

Copy link
Contributor

Choose a reason for hiding this comment

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

I think the GitHub command line tools do let you mark a PR as draft, and also to mark it ready for review: gh pr create --draft.

@tengqm
Copy link
Contributor

tengqm commented Dec 10, 2020

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 10, 2020
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 24c8e800bc48947c4cb982f153468abb83d9a2c8

@jimangel
Copy link
Member

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jimangel

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 Dec 15, 2020
@k8s-ci-robot k8s-ci-robot merged commit 91e688c into kubernetes:master Dec 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tengqm tengqm tengqm left review comments

@sftim sftim sftim left review comments

@daminisatya daminisatya Awaiting requested review from daminisatya

@rajeshdeshpande02 rajeshdeshpande02 Awaiting requested review from rajeshdeshpande02

Assignees

@jimangel jimangel

@tengqm tengqm

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@annajung @tengqm @k8s-ci-robot @jimangel @sftim