docs: document all unstable configurations (#20336) #20438
Conversation
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]>
| [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.
There was a problem hiding this comment.
You are also referencing the links in the new section below which makes it confusing to find where they are defined. This type of markdown links are called Reference and usually you put references at the bottom of the file. You can read more about it here:
https://google.github.io/styleguide/docguide/style.html#reference
There was a problem hiding this comment.
Let me explain in more details why I think, in this case, reference links should be put under the main table: if a contributor updates the page to add their new fields to the list, it is very easy to scroll down, add the links and be done with it. When that happens, the main overview table would become incomplete. If the links are placed directly underneath the main overview table, it becomes more obvious to update the overview table.
But I'll move them to the bottom if markdown styling is more important.
| [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.
You are also referencing the links in the new section below which makes it confusing to find where they are defined. This type of markdown links are called Reference and usually you put references at the bottom of the file. You can read more about it here:
https://google.github.io/styleguide/docguide/style.html#reference
Signed-off-by: Alexandre Gaudreault <[email protected]>
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.