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

Update release notes todos section and add debugging tips #2500

Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions release-team/role-handbooks/release-notes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,11 +214,13 @@ Begin running release-notes tool for the ongoing collection of release notes wit
- __Release day__
- Copy notes from Google Doc to HackMD in markdown
- Final version of release notes committed for release
- Close the _Known Issues_ Issue is and make sure everything has been resolved
npolshakova marked this conversation as resolved.
Show resolved Hide resolved
- Release Notes must be merged into master prior to the release. If this is not done the release will include the latest draft.

### Week 19

- Release retrospective participation
- Update the TODOs section at the end of each release for the next Release Notes Team
npolshakova marked this conversation as resolved.
Show resolved Hide resolved

## Tools
- [krel](https://github.com/kubernetes/release/tree/master/docs/krel) The Kubernetes Release Toolbox
Expand All @@ -230,17 +232,35 @@ Begin running release-notes tool for the ongoing collection of release notes wit
- [LWKD](http://lwkd.info) *(consider contributing to LWKD as part of your role)*
- [Kubernetes Documentation Style Guide](https://kubernetes.io/docs/contribute/style/style-guide/)

## Debugging Tips

If you are having trouble running the `krel` tool, here are some common issues and solutions:

1. Try running with `--log-level=debug` or `--log-level=trace` to get more information about what is going wrong.
npolshakova marked this conversation as resolved.
Show resolved Hide resolved

Checkout the documentation for the [krel `release-notes` subcommand](https://github.com/kubernetes/release/blob/master/docs/krel/release-notes.md).

## TODOs

Update this section at the end of each release for the next Release Notes Team.
As a Release Notes shadow, if you are interested in contributing to the improvement of the release notes process, consider the following
areas of improvement:

### Post 1.17 TODOs
#### Github Workflow to Detect Common Release Note Issues

#### If any team members have NLP experience
- yaml linter to block invalid yaml merging in from manually edited release notes
- spell check based on dictionary of common Kubernetes terms
- check for correct punctuation in release notes
- check for incorrect tense in release notes
npolshakova marked this conversation as resolved.
Show resolved Hide resolved

Implement functionality in release-notes tool to automatically process language in generated release notes file
#### Release Notes tool to automatically process language

If any team members have NLP experience, implement functionality in release-notes tool to automatically process language in generated release notes file

Goals:

- Generate uniform style across release notes (ie. past tense, formatting)
- Decrease copy editing time

#### Krel tool improvements

- Update krel tool to show progress of how many PRs to review are left and other bugs