-
Notifications
You must be signed in to change notification settings - Fork 197
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
confine backup and restore breaking changes to the version they were introduced #4829
base: main
Are you sure you want to change the base?
Conversation
👋 🤖 🤔 Hello, @conceptualshark! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
Just a note that I'm unsure who to tag specifically for an engineering review, so I've dropped an ask with the Zeebe team to take a look. |
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.
For Optimize, this change was introduced with 8.2. Lets remove the notice from all >8.2 for Optimize (for the other components I do not know which is the correct version). See slack thread
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.
Lgtm for Optimize
Adding the EMs as reviewers for Operate and Tasklist. |
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.
Removing the paragraphs as in the diff makes a lot of sense to me.
I'd like to suggest to add a section to the 8.6 section of the Announcements page, where we put this content centrally: https://docs.camunda.io/docs/reference/announcements/#camunda-86
My reasoning is that people will continue updating Camunda from 8.5 to 8.6 and they will confuse which docs version they are on, so it's even easier to miss this change now (it was already before, because it was listed not on the central migration page).
Btw I believe this section has the wrong heading level: https://docs.camunda.io/docs/reference/announcements/#zeebe-spring-sdk-test-support-in-867
edit: you can also take my review on behalf of @marcosgvieira, I think we don't need to have his review to merge this.
910c2e1
@ThorbenLindhauer I've added this to both the 8.6 announcement pages for visibility (And fixed that heading's indentation!), if you are able to review again! |
@conceptualshark Thank you. We should also add the changes to the backup endpoints there, or? And for the default actuator ports, let's mention the components that are affected by this. |
@ThorbenLindhauer @akeller Do you think the older changes introduced in 8.2 are worth placing into the historical announcements? There's no centralized place for 8.2 docs any longer, so that's the only place they could be listed. Can you confirm that Operate and Tasklist are the only components impacted by the actuator port change? Thank you! |
Sounds fine to me.
I don't know. We can either just document what we are seeing here or ask around in the different component teams. |
This should now:
|
The preview environment relating to the commit ef6b21e has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4829/index.html |
Description
Messaging around breaking changes has been introduced periodically into the SM backup and restore docs, and then duplicated when new versions are cut. This leads to confusions around when a breaking change applies.
This PR confines breaking change messaging to the versions they were introduced. This PR does not include any messaging around 8.7/ in /next, as that messaging should be added when the new backup and restore procedures and changes are complete.
Breaking change notifications should remain in the operate/tasklist doc for 8.6 for the new changes introduced there.
Internal slack ask: https://camunda.slack.com/archives/C026U8GBNSW/p1736376448383119
When should this change go live?
hold
label or convert to draft PR)PR Checklist
/versioned_docs
directory./docs
directory (aka/next/
).