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

Release Notes (correction) #17559

Merged
merged 1 commit into from
Nov 14, 2019
Merged

Release Notes (correction) #17559

merged 1 commit into from
Nov 14, 2019

Conversation

butuzov
Copy link
Contributor

@butuzov butuzov commented Nov 13, 2019

The link to the CRD page ( check link in CustomResourceDefaulting
description of Beta section) corrected (before its was generating 404
due to an encoded anchor symbol.).

The link to the CRD page ( check link in CustomResourceDefaulting
description of Beta section) corrected.
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Nov 13, 2019
@butuzov
Copy link
Contributor Author

butuzov commented Nov 13, 2019

/assign @tengqm

@netlify
Copy link

netlify bot commented Nov 13, 2019

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

Built with commit 2a56429

https://deploy-preview-17559--kubernetes-io-master-staging.netlify.com

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 13, 2019
@sftim
Copy link
Contributor

sftim commented Nov 13, 2019

Does this need correcting anywhere upstream? Or a fix to the generator code?

@butuzov
Copy link
Contributor Author

butuzov commented Nov 13, 2019

@sftim good and valid point. kubernetes/kubernetes#82252 and kubernetes/kubernetes#81872 both introducing a link with anchor: one proccessed "ok", one "isn't".

Who can we ask about the generator and how it works?

@tengqm
Copy link
Contributor

tengqm commented Nov 14, 2019

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tengqm

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 14, 2019
@k8s-ci-robot k8s-ci-robot merged commit 1f60267 into kubernetes:master Nov 14, 2019
@tengqm
Copy link
Contributor

tengqm commented Nov 14, 2019

I just did some research on this. It looks like the upstream code is here:
https://github.com/kubernetes/release/blob/master/pkg/notes/notes.go#L519

For release notes to be properly processed by the code, the notes itself is supposed to be put under "Does this PR introduce a user-facing change" section in the commit message. E.g. kubernetes/kubernetes/#82252For some reasons, we have PRs not doing this, e.g. kubernetes/kubernetes/#81872. The generator has some logic to process the notes in different ways: https://github.com/kubernetes/release/blob/master/pkg/notes/notes.go#L262

@butuzov butuzov deleted the release-notes-link branch November 14, 2019 07:50
@butuzov
Copy link
Contributor Author

butuzov commented Nov 14, 2019

@tengqm Will you handle it? (i am not familiar with release tools) or I guess there is a slack channel about releases where members can be interested in this info...

neolit123 pushed a commit to neolit123/website that referenced this pull request Nov 14, 2019
The link to the CRD page ( check link in CustomResourceDefaulting
description of Beta section) corrected.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants