-
Notifications
You must be signed in to change notification settings - Fork 188
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
clarify possible instances of zeebe rollback #4064
Conversation
@@ -163,6 +163,10 @@ If the error is caused by `Cannot upgrade to or from a pre-release version`, Zee | |||
This is not permitted because pre-release versions such as alpha releases are considered unstable and do not guarantee compatibility with any other version. | |||
If you attempted to update from a normal version to a pre-release version, you can roll back to the previous normal version. | |||
|
|||
:::note | |||
While in most instances version rollbacks are not supported, in this particular use case a version rollback is possible. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While in most instances version rollbacks are not supported, in this particular use case a version rollback is possible. | |
While in most instances version rollbacks are not supported, in this particular use case a version rollback of Zeebe is possible because the "new" version never became active, thanks to the safety check. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure the extra explanation adds a lot here. We don't otherwise talk about what the safety checks or doing, and can possibly introduce new points of confusion re: "new" vs "old" instead of clarifying. If we really think our developers need this info, I'd suggest something like:
..a version rollback of Zeebe is possible, as the included safety checks prevented the pre-release version from becoming active.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd keep the addition of "Zeebe" then because rollback of the other applications might not be possible.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated in latest commit -- let me know what you think.
@@ -163,6 +163,10 @@ If the error is caused by `Cannot upgrade to or from a pre-release version`, Zee | |||
This is not permitted because pre-release versions such as alpha releases are considered unstable and do not guarantee compatibility with any other version. | |||
If you attempted to update from a normal version to a pre-release version, you can roll back to the previous normal version. | |||
|
|||
:::note | |||
While in most instances version rollbacks are not supported, in this particular use case a version rollback is possible. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure the extra explanation adds a lot here. We don't otherwise talk about what the safety checks or doing, and can possibly introduce new points of confusion re: "new" vs "old" instead of clarifying. If we really think our developers need this info, I'd suggest something like:
..a version rollback of Zeebe is possible, as the included safety checks prevented the pre-release version from becoming active.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 This looks clear to me!
Description
Closes https://github.com/camunda/developer-experience/issues/345.
Clarifying unique instances of rollback.
When should this change go live?
hold
label or convert to draft PR)PR Checklist
/versioned_docs
directory./docs
directory (aka/next/
).