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

confine backup and restore breaking changes to the version they were introduced #4829

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

conceptualshark
Copy link
Contributor

@conceptualshark conceptualshark commented Jan 9, 2025

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?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@conceptualshark conceptualshark changed the title confine breaking changes to the version they were introduced confine backup and restore breaking changes to the version they were introduced Jan 9, 2025
Copy link
Contributor

github-actions bot commented Jan 9, 2025

👋 🤖 🤔 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/.

  • docs/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md

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.

@conceptualshark conceptualshark added the kind/feature Issues related with features to be documented label Jan 9, 2025
@conceptualshark conceptualshark requested a review from a team January 9, 2025 19:57
@conceptualshark
Copy link
Contributor Author

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.

@conceptualshark conceptualshark requested review from entangled90 and removed request for entangled90 January 14, 2025 13:46
Copy link
Contributor

@PHWaechtler PHWaechtler left a 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

@conceptualshark
Copy link
Contributor Author

Based on the above comment, I also tracked down the Operate/Tasklist changes to 8.2 here and here; I've gone ahead and removed these warnings from 8.3, but would still appreciate a final confirmation.

Copy link
Contributor

@PHWaechtler PHWaechtler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm for Optimize

@akeller
Copy link
Member

akeller commented Jan 15, 2025

Adding the EMs as reviewers for Operate and Tasklist.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Issues related with features to be documented
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

4 participants