docs: document all unstable configurations (#20336) #20438
+76
−15
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Alexandre Gaudreault <[email protected]>
✅ Preview Environment deployed on Bunnyshell
See: Environment Details | Pipeline Logs Available commands (reply to this comment):
|
Signed-off-by: Alexandre Gaudreault <[email protected]>
Signed-off-by: Alexandre Gaudreault <[email protected]>
Signed-off-by: Alexandre Gaudreault <[email protected]>
…-cd into feature-parity-doc
Signed-off-by: Alexandre Gaudreault <[email protected]>
leoluz
requested changes
Oct 18, 2024
Comment on lines
29
to
+37
| [2]: applicationset/Progressive-Syncs.md | ||
| [3]: ../developer-guide/extensions/proxy-extensions.md | ||
| [4]: ../user-guide/skip_reconcile.md | ||
| [5]: applicationset/Appset-Any-Namespace.md | ||
| [6]: dynamic-cluster-distribution.md | ||
| [7]: ../user-guide/diff-strategies.md#server-side-diff | ||
| [8]: app-sync-using-impersonation.md | ||
| [6]: ./high_availability.md#argocd-application-controller | ||
| [7]: dynamic-cluster-distribution.md | ||
| [8]: ../user-guide/diff-strategies.md#server-side-diff | ||
| [9]: ./high_availability.md#argocd-application-controller | ||
| [10]: app-sync-using-impersonation.md |
There was a problem hiding this comment.
Please always keep the link section at the bottom of the file for easy reference.
There was a problem hiding this comment.
The links section can be placed anywhere in the file. In this case, I think it is much easier to have these link directly under the main overview table.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #20336
Add all the fields in the doc that are subject to breaking changes or removal. This aims to clarify what should and should not be used by users and/or vendors.
Previous discussions with the community highlighted that spec fields on the CRD are falsely considered more "stable", than annotations.