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

charms docs: Add 1.32 charms release notes #913

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

HomayoonAlimohammadi
Copy link
Contributor

Overview

This PR adds the 1.32 Canonical Kubernetes charms release notes.

@HomayoonAlimohammadi HomayoonAlimohammadi force-pushed the KU-2363/k8s-operator-1.32-release-notes branch from 508182b to ae67186 Compare December 18, 2024 12:21
@HomayoonAlimohammadi HomayoonAlimohammadi marked this pull request as ready for review December 18, 2024 12:22
@HomayoonAlimohammadi HomayoonAlimohammadi requested a review from a team as a code owner December 18, 2024 12:22
@HomayoonAlimohammadi HomayoonAlimohammadi changed the title Draft: Add 1.32 charms release notes charms docs: Add 1.32 charms release notes Dec 18, 2024
Copy link
Contributor

@nhennigan nhennigan left a comment

Choose a reason for hiding this comment

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

Looks great so far. Just a small nit on one of the links

docs/src/charm/reference/versions/1.32.md Outdated Show resolved Hide resolved
Copy link
Contributor

@louiseschmidtgen louiseschmidtgen left a comment

Choose a reason for hiding this comment

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

Fantastic work @HomayoonAlimohammadi, I've got some minor suggestions.

@nhennigan is this the correct place for the release notes? Should they rather live under our top-level release notes section?

docs/src/charm/reference/releases.md Outdated Show resolved Hide resolved
docs/src/charm/reference/versions/1.32.md Outdated Show resolved Hide resolved
docs/src/charm/reference/versions/1.32.md Outdated Show resolved Hide resolved
docs/src/charm/reference/versions/1.32.md Show resolved Hide resolved
docs/src/charm/reference/versions/1.32.md Outdated Show resolved Hide resolved
Comment on lines +51 to +54
## Also in this release

- Replace `AssertionError` with `ReconcileError` [#173]
- Renames `annotations` to `cluster-annotations` in charm config [#198]
- Add `kube-apiserver-extra-sans` option [#201]
- Add worker `bootstrap-node-taints` setting [#215]
- Enhance status visibility during cluster upgrades [#216]
Copy link
Contributor

Choose a reason for hiding this comment

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

Can this join the bug fixes/ what's new section?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I thought that this does not really fit the "bug fixes" section since these are not really bugs. Also for the "what's new?" section these are too small IMO. If you agree, I think it's best to keep them like this. It was also inspired by what @nhennigan did for 1.32 snap.

docs/src/charm/reference/versions/1.32.md Outdated Show resolved Hide resolved
@nhennigan
Copy link
Contributor

nhennigan commented Dec 20, 2024

@nhennigan is this the correct place for the release notes? Should they rather live under our top-level release notes section?

I plan on changing the sidebar navigation so that we can see both charm and snap release notes. Once this PR is reabsed to include the 1.32 snap notes, I'll add my changes. The docs/canonicalk8s/src/_parts/install.md will also need to be updated to stable so I'll add that too.

@HomayoonAlimohammadi HomayoonAlimohammadi force-pushed the KU-2363/k8s-operator-1.32-release-notes branch from 72d22bd to 21d4831 Compare December 20, 2024 12:48
@HomayoonAlimohammadi
Copy link
Contributor Author

Once this PR is reabsed to include the 1.32 snap notes, I'll add my changes.

@nhennigan It's rebased now. Thanks!

Update charm channel to 1.32 stable. Reoganise the navigation side bar to be able to see both snap and charm release notes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants