Sig-release: Add links to relevant docs in Release Notes

Created on 14 Jun 2019 · 8Comments · Source: kubernetes/sig-release

Per https://kubernetes.slack.com/archives/C2C40FMNF/p1560536323319700

It'd be awesome if, in the release notes, we link to new and/or relevant documentation on the K8s website. I think this is entirely reasonable and something that should be looked into in the next release or so.

With the website it would be relatively easy and painless to add a new (optional) field in the JSON. That way it could be captured by either a field in the PR template OR a separate PR to update the JSON with the doc(s) link.

arerelease-eng kinfeature prioritimportant-longterm sirelease

Source

jeefy

👍2

Most helpful comment

/assign @saschagrunert @jeefy

jeefy on 14 Jun 2019

👍2

All 8 comments

/kind feature
/area release-eng
/priority important-longterm

jeefy on 14 Jun 2019

/assign @saschagrunert @jeefy

jeefy on 14 Jun 2019

👍2

How about adding an additional section to the PR template, which could be parsed by the release-notes tool afterwards:

\   ```documentation
\    - Link
\    - Link
\    - Link
\   ```

saschagrunert on 19 Jun 2019

👍1

@saschagrunert
I think it's a great idea.

I think we would need to parse the links to make sure that they are on the Kubernetes website. Other things to keep in mind are links changing on the website overtime. A final thing thing to address would be irrelevant links. What if people added a link to the main kubernetes website for their PR. Would that really be relevant if it appeared dispersed over 20 PRs or so?

pswica on 19 Jun 2019

What if people added a link to the main kubernetes website for their PR. Would that really be relevant if it appeared dispersed over 20 PRs or so?

Yeah I guess we have to review the PRs with keeping in mind that the documentation links will appear in the release-notes and need to add valuable benefits to the users. Nevertheless we can parse all URLs and classify them by the location. So we would be able to separate KEP links or filter only for KEPs inside the website.

saschagrunert on 20 Jun 2019

@jeefy do we want to close this or is there anything else which needs to be done? :)

saschagrunert on 29 Jul 2019

🌮

/close

jeefy on 29 Jul 2019

@jeefy: Closing this issue.

In response to this:

🌮

/close

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.