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 10 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/reference/announcements/860.md
  • docs/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md
These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.7/.
  • docs/reference/announcements.md
  • docs/reference/announcements/860.md
  • docs/self-managed/operational-guides/backup-restore/backup-and-restore.md
  • docs/self-managed/operational-guides/backup-restore/operate-tasklist-backup.md
  • docs/self-managed/operational-guides/backup-restore/optimize-backup.md
These files were changed only in versioned_docs/version-8.6/. You might want to duplicate these changes in versioned_docs/version-8.7/.
  • versioned_docs/version-8.6/reference/announcements.md
  • versioned_docs/version-8.6/self-managed/operational-guides/backup-restore/backup-and-restore.md
  • versioned_docs/version-8.6/self-managed/operational-guides/backup-restore/optimize-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.

PHWaechtler
PHWaechtler previously approved these changes Jan 15, 2025
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.

@akeller akeller added component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed low prio There is no urgency with this change. labels Jan 24, 2025
Copy link
Member

@ThorbenLindhauer ThorbenLindhauer left a 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.

@conceptualshark
Copy link
Contributor Author

@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!

@ThorbenLindhauer
Copy link
Member

@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.

@conceptualshark
Copy link
Contributor Author

@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!

@ThorbenLindhauer
Copy link
Member

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.

Sounds fine to me.

Can you confirm that Operate and Tasklist are the only components impacted by the actuator port change?

I don't know. We can either just document what we are seeing here or ask around in the different component teams.

@conceptualshark
Copy link
Contributor Author

This should now:

  • Remove the warning changing backup -> backups in all versions, and the warning about backup API changes, as this was introduced in 8.2. A note has been added to the 8.2 announcements in versions 8.3 - 8.6.
  • Remove the actuator port change from 8.8 (leaving it in 8.6, where it was introduced, and 8.7, as a warning for upgrading). A note has been added to the 8.6 announcements.

@conceptualshark conceptualshark added the deploy Stand up a temporary docs site with this PR label Feb 24, 2025
@github-actions github-actions bot temporarily deployed to camunda-docs February 24, 2025 20:37 Destroyed
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed deploy Stand up a temporary docs site with this PR kind/feature Issues related with features to be documented low prio There is no urgency with this change.
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

5 participants