Note that upgrades to ECK 3.1 cause a restart

[pebrc]

I would like to add a note that the restart only happens if the user is make use of the stack monitoring feature in ECK but I don't know the best way to express that in the docs syntax.

Normally I would have wanted to add a footnote but I don't think we have those in the docs/markdown. Open for suggestions. If there is no good way that an unqualified mention is still better than the status quo.

[github-actions]

🔍 Preview links for changed docs

• deploy-manage/upgrade/orchestrator/upgrade-cloud-on-k8s.md

[kilfoyle]

@pebrc I think there are two options:

Using a code callout:

(three backticks)
1.6, 1.9, 2.0, 2.1, 2.2, 2.4, 2.5, 2.6, 2.7, 2.8, 2.14, 3.1 <1>
(three backticks)

1. The restart happens only if you're using the stack monitoring feature in ECK.

Which renders like this:

One problem is that the admonition must appear at the end of the line.

---

Alternatively, we could update the admonition that appears below the versions list:

(three backticks)
1.6, 1.9, 2.0, 2.1, 2.2, 2.4, 2.5, 2.6, 2.7, 2.8, 2.14, 3.1
(three backticks)
::::{admonition} Notes
Note the following about rolling restarts:
- The restart only happens if the user is making use of the stack monitoring feature in ECK. 
- Stepping over one of these versions, for example, upgrading ECK from 2.6 to 2.9, still triggers a rolling restart.
::::

which renders like this:

[pebrc]

@kilfoyle thanks for the suggestions. I think the problem is that is not clear to the reader which version it applies to. Especially in the second version (which implies it applies to all version and that would be wrong).

I think I am going with the callout and mention the version explicitly again in the text.

[kilfoyle]

I think I am going with the callout and mention the version explicitly again in the text.

I think that's a good approach. Note that the callout has to appear at the end of the line:

this works: 1.6, 1.9, 2.0, 2.1, 2.2, 2.4, 2.5, 2.6, 2.7, 2.8, 2.14, 3.1, 3.2, 3.3, 3.4 <1>
this doesn't work: 1.6, 1.9, 2.0, 2.1, 2.2, 2.4, 2.5, 2.6, 2.7, 2.8, 2.14, 3.1 <1>, 3.2, 3.3, 3.4

So, it would be important to include the version explicitly in the text.

[kilfoyle]

LGTM! 🚀