Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Don't mark pre-upgrade step as "recommended" #18468

Merged
merged 1 commit into from
Jan 17, 2022

Conversation

pchaigno
Copy link
Member

In the upgrade guide, we recommend to first upgrade to the latest patch release before upgrading to a new minor release, to ensure downgrade will work if ever needed. This commit removes the "Recommended" tag on the step title. The worry is that a user who goes a bit too quickly through the guide may skip that step just because it's marked "recommended". Instead the user should read the short text to make an informed decision.

(Discussed before the holidays with Joe and Martynas.)

In the upgrade guide, we recommend to first upgrade to the latest patch
release before upgrading to a new minor release, to ensure downgrade
will work if ever needed. This commit removes the "Recommended" tag on
the step title. The worry is that a user who goes a bit too quickly
through the guide may skip that step just because it's marked
"recommended". Instead the user should read the short text to make an
informed decision.

Signed-off-by: Paul Chaignon <paul@cilium.io>
@pchaigno pchaigno added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact. needs-backport/1.11 labels Jan 13, 2022
@pchaigno pchaigno requested a review from a team as a code owner January 13, 2022 09:19
@pchaigno pchaigno added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Jan 14, 2022
@aditighag aditighag merged commit 31ce04e into cilium:master Jan 17, 2022
@pchaigno pchaigno deleted the docs-recommended-upgrade-path branch January 17, 2022 16:24
@kkourt kkourt added backport-done/1.11 The backport for Cilium 1.11.x for this PR is done. and removed backport-pending/1.11 labels Jan 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. backport-done/1.11 The backport for Cilium 1.11.x for this PR is done. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants