docs: add breaking changes page for cross-namespace default change#37
docs: add breaking changes page for cross-namespace default change#37kprahulraj wants to merge 1 commit into
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: kprahulraj The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
kprahulraj
force-pushed
the
feat/cross-namespace-default-change
branch
5 times, most recently
from
79e2e8f to
2347a20
Compare
|
This should be added along with the feature to support enable cross namespace |
jlbutler
left a comment
jlbutler
left a comment
There was a problem hiding this comment.
looks good, left a few comments / followups
| ## Documenting Breaking Changes | ||
|
|
||
| If your PR introduces a breaking change (e.g., changing a default value, removing a flag, altering reconciliation behavior), you must update the [Breaking Changes](/docs/breaking-changes) page. | ||
|
|
There was a problem hiding this comment.
can we open an issue to make a corresponding guidance change in the ack-dev skill?
There was a problem hiding this comment.
|
|
||
| # Breaking Changes | ||
|
|
||
| This page tracks upcoming breaking changes to ACK controller defaults and behavior. Review this page before upgrading your controllers. |
There was a problem hiding this comment.
upcoming only, or does this page also track previously communicated and shipped breaking changes?
There was a problem hiding this comment.
Good point - this should track both upcoming and previously shipped breaking changes. Do you have a list of previous breaking changes that I can add here? I'll update the wording once we have those documented
| :::warning[Breaking Change Notice] | ||
| The default value of `--enable-cross-namespace` will change from `true` to `false` in a future release. | ||
| ::: | ||
|
|
There was a problem hiding this comment.
We might explicitly say "The warning serves as a deprecation notice of existing default functionality". Up to you if you'd like to include that.
…amespace default change - Add Breaking Changes page at top-level sidebar (same level as Overview, Getting Started) - Add Documenting Breaking Changes guideline to Contributing section - Add New badge to Breaking Changes and Contributing - Remove New badge from EKS Capabilities, Granular IAM Roles, Using ACK with kro
kprahulraj
force-pushed
the
feat/cross-namespace-default-change
branch
from
2347a20 to
4a3ec5a
Compare
2 participants
Description of changes:
add breaking changes page for cross-namespace default change
Newtag to contributing and breaking changesThis will be requirement when we add the feature to support enable cross namespace
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.