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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the PR template for latest 'additional documentation' enhancements #81159

Open
wants to merge 2 commits into
base: master
from

Conversation

@saschagrunert
Copy link
Member

commented Aug 8, 2019

What type of PR is this?

/kind documentation

What this PR does / why we need it:

  • Mention the relnotes.k8s.io website
  • Clarify the ephemerality of web resouces

Which issue(s) this PR fixes:

Fixes kubernetes-sigs/release-notes#91
Refers to kubernetes/sig-release#729

Special notes for your reviewer:

Is there anything I forgot? 馃憖

Does this PR introduce a user-facing change?:

NONE

/cc @justaugustus @jeefy @guineveresaenger @mrbobbytables

@k8s-ci-robot

This comment has been minimized.

Copy link
Contributor

commented Aug 8, 2019

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: saschagrunert
To complete the pull request process, please assign phillels
You can assign the PR to them by writing /assign @phillels in a comment when ready.

The full list of commands accepted by this bot can be found 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

@saschagrunert

This comment has been minimized.

Copy link
Member Author

commented Aug 8, 2019

/retest

@saschagrunert

This comment has been minimized.

Copy link
Member Author

commented Aug 8, 2019

/test pull-kubernetes-e2e-gce-device-plugin-gpu

@jeefy
Copy link
Member

left a comment

Minor nits about phrasing and succinctness, overall happy about the additional direction!

Show resolved Hide resolved .github/PULL_REQUEST_TEMPLATE.md Outdated
Show resolved Hide resolved .github/PULL_REQUEST_TEMPLATE.md Outdated
Show resolved Hide resolved .github/PULL_REQUEST_TEMPLATE.md Outdated
Update the PR template for latest 'additional documentation' enhancem鈥
鈥nts

- Mention the relnotes.k8s.io website
- Clarify the ephemerality of links

Signed-off-by: Sascha Grunert <sgrunert@suse.com>

@saschagrunert saschagrunert force-pushed the openSUSE:pr-template-update-2 branch from fca5ca2 to af1c3bb Aug 12, 2019

@saschagrunert

This comment has been minimized.

Copy link
Member Author

commented Aug 12, 2019

Minor nits about phrasing and succinctness, overall happy about the additional direction!

Thanks for the review, I changed is as suggested. 馃憤

@justaugustus

This comment has been minimized.

Copy link
Member

commented Aug 12, 2019

/hold

@nikhita

This comment has been minimized.

Copy link
Member

commented Aug 12, 2019

@k8s-ci-robot k8s-ci-robot requested review from cblecker and nikhita Aug 12, 2019

@nikhita

This comment has been minimized.

Copy link
Member

commented Aug 12, 2019

/sig release

be able to provide additional documentation to the end users about the changes
in this PR.
If you decide to add links which point to resources within git repositories,

This comment has been minimized.

Copy link
@cblecker

cblecker Aug 12, 2019

Member

This sentence isn't clear on the surface. I'm not sure what you're asking of me as a contributor.

This comment has been minimized.

Copy link
@saschagrunert

saschagrunert Aug 13, 2019

Author Member

Something like:

For KEPs or other supporting documentation, please link to a specific commit
and avoid linking directly to master. See <link> for further guidelines.

I picked-up the comment of @mrbobbytables and rephrased the paragraph. WDYT?

@guineveresaenger
Copy link
Contributor

left a comment

I'm not entirely sure we need to mention relnotes in the template - if the actual process for adding a release note is no different for the user than before, I don't think we need to add it here.

The document on release notes should be updated, however.

The Kubernetes Release Notes website (https://relnotes.k8s.io) is able to
provide additional documentation to the end users, which should help them to
be able to provide additional documentation to the end users about the changes
in this PR.

This comment has been minimized.

Copy link
@guineveresaenger

guineveresaenger Aug 12, 2019

Contributor

Could you clean up this sentence a bit, I think it's saying the same thing twice? It should also go under the release notes heading staring on line 36, not on the "additional documentation" heading.

This comment has been minimized.

Copy link
@mrbobbytables

mrbobbytables Aug 12, 2019

Member

I'm not entirely sure we need to mention relnotes in the template - if the actual process for adding a release note is no different for the user than before, I don't think we need to add it here.

The document on release notes should be updated, however.

It might still be worth adding a small hint that external references to KEPs etc should link to a specific commit rather than master and fleshing out further instructions details in the release notes doc.
Something like:

For KEPs or other supporting documentation, please link to a specific commit
and avoid linking directly to master. See <link> for further guidelines.

This comment has been minimized.

Copy link
@saschagrunert

saschagrunert Aug 13, 2019

Author Member

Could you clean up this sentence a bit, I think it's saying the same thing twice? It should also go under the release notes heading staring on line 36, not on the "additional documentation" heading.

I removed the section entirely, because I would like to pick up the discussion if its needed at all or not. WDYT?

This comment has been minimized.

Copy link
@guineveresaenger

guineveresaenger Aug 13, 2019

Contributor

yes! my main concern is honestly that we document the relnotes in the relevant doc, which we link to on top!

@k8s-ci-robot k8s-ci-robot removed the size/S label Aug 13, 2019

@guineveresaenger

This comment has been minimized.

Copy link
Contributor

commented Aug 13, 2019

question! @saschagrunert I understand that #81278 is also being worked on, but I'm happy having this be its own PR. Let me know your preference!

@saschagrunert saschagrunert force-pushed the openSUSE:pr-template-update-2 branch from 5abd9fb to 1cd549e Aug 14, 2019

@saschagrunert

This comment has been minimized.

Copy link
Member Author

commented Aug 14, 2019

question! @saschagrunert I understand that #81278 is also being worked on, but I'm happy having this be its own PR. Let me know your preference!

Yes I would prefer having this on its own since the main trigger for it was kubernetes-sigs/release-notes#91, which is a stand-alone topic.

@guineveresaenger

This comment has been minimized.

Copy link
Contributor

commented Aug 14, 2019

/lgtm

Thank you for adding this!

Removed section about website mentioning
Signed-off-by: Sascha Grunert <sgrunert@suse.com>

@saschagrunert saschagrunert force-pushed the openSUSE:pr-template-update-2 branch from 1cd549e to 607b31f Aug 15, 2019

@k8s-ci-robot k8s-ci-robot removed the lgtm label Aug 15, 2019

@k8s-ci-robot

This comment has been minimized.

Copy link
Contributor

commented Aug 15, 2019

New changes are detected. LGTM label has been removed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can鈥檛 perform that action at this time.