Administration/Upgrading: Add index page for "Upgrading" section #43
Conversation
amotl
changed the title
amotl
changed the title
amotl
requested review from
surister,
hammerhead,
hlcianfagna and
proddata
and removed request for
hlcianfagna,
seut and
surister
This comment was marked as resolved.
This comment was marked as resolved.
amotl
force-pushed
the
amo/compress-upgrade
branch
from
0dcd4e2
to
14591f5
Compare
This comment was marked as resolved.
This comment was marked as resolved.
docs/admin/upgrade/index.md
Outdated
| # Upgrading | ||
|
|
||
| Guidelines about upgrading CrateDB clusters. | ||
|
|
||
| ```{toctree} | ||
| :maxdepth: 2 | ||
|
|
||
| planning | ||
| rolling | ||
| full | ||
| ``` |
There was a problem hiding this comment.
Also, now that we are talking about it, what do you think about improving the wording by stripping redundancy, at least on the labels within the primary navigation?
There was a problem hiding this comment.
I think "Rolling Upgrade" and "Full Restart Upgrade" are fine there.
"General Guidelines" or "Guidelines" might be sufficient though.
Spend a little index page on the "Upgrading" section, in order to save vertical space within the primary navigation, and to improve guidance.
amotl
force-pushed
the
amo/compress-upgrade
branch
from
14591f5
to
0fbf289
Compare
| Guidelines <planning> | ||
| rolling | ||
| full |
There was a problem hiding this comment.
I've adjusted the patch correspondingly to use "Guidelines" as the label within the primary navigation. The page title itself hasn't been changed, and is still "General Upgrade Guidelines".
There was a problem hiding this comment.
One could just move the "Guidelines" into "Upgrading", as the Execution part just links to Rolling / Full Upgrade
There was a problem hiding this comment.
We have to admit we are only looking at the most prominent details mostly on the 1st level of this documentation tree now, with only occasional detours into the 2nd and 3rd levels. We will carry that over to a subsequent iteration, thanks.
About
Spend a little index page on the "Upgrading" section, in order to save vertical space within the primary navigation, and to improve guidance.
Before / After
With screenshots.
Preview
/cc @surister, @karynzv, @marijaselakovic, @hammerhead, @proddata, @wierdvanderhaar, @msbt, @matkuliak