Adds a warning in the upgrade doc about split cluster #17755
Conversation
|
Commit 66695fce7612badadee2bacbffc7eeb13611577a does not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin |
maintainer-s-little-helper
bot
added
dont-merge/needs-sign-off
|
Commit 66695fce7612badadee2bacbffc7eeb13611577a does not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin |
Weil0ng
added
release-note/misc
There was a problem hiding this comment.
The PR message says to look at the commit message, but the commit message is empty. Were you meaning to point out something else from the PR description?
I've added a couple of notes. It's always tempting to highlight the one extra doc piece that you are submitting as a developer in either a .. note:: or .. warning:: box, but if everyone does this then we don't end up with a flowing document that describes the functionality of the software, we just end up with a series of notes and warnings. While this is important, I don't think that we need to raise specific attention to it in a warning box; it's enough to document it as part of the guide as standard text.
| @@ -4,6 +4,12 @@ | |||
| Please use the official rendered version released here: | |||
| https://docs.cilium.io | |||
|
|
|||
| .. warning:: | |||
There was a problem hiding this comment.
Looking at the preview, I think we would ideally integrate this text into the guide somewhere a bit more naturally rather than as the first warning that appears on the page. While this is an important point, I don't think that it needs to be the first thing on the page and it probably doesn't need to be called out in a warning box. The upgrade guide has barely started at this point and this would mean there are already two warnings 🤔
There was a problem hiding this comment.
Done. Curious how did you get the preview line? (I tested the change locally via make render-docs)
There was a problem hiding this comment.
The link? We haven't had this for too long, but if you scroll down to the bottom in the checks, there is one called deploy/netlify. If you click on "Details" there then it'll provide a preview of the PR docs.
Signed-off-by: Weilong Cui <cuiwl@google.com>
maintainer-s-little-helper
bot
moved this from Needs backport from master
to Backport pending to v1.10
in 1.10.6
maintainer-s-little-helper
bot
moved this from Backport pending to v1.10
to Backport done to v1.10
in 1.10.6
maintainer-s-little-helper
bot
moved this from Backport pending to v1.10
to Backport done to v1.10
in 1.10.6
See commit msg.
We saw "split" cluster (mismatching agent and operator versions) causing weird behaviors (e.g., #17192), adding a warning in upgrade guide to discourage running "split" clusters.