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(java-client): add announcement of zeebe java client deprecation #4051

Merged
merged 5 commits into from
Aug 2, 2024

Conversation

nicpuppa
Copy link
Contributor

@nicpuppa nicpuppa commented Jul 19, 2024

Description

Add an announcement regarding Zeebe Java Client deprecation in 8.7, to be replaced by Camunda Client

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/).

closes: #4047

@nicpuppa nicpuppa added the target:8.6 Issues included in the 8.6 release label Jul 19, 2024
@nicpuppa nicpuppa requested review from megglos, MaxTru and a team July 19, 2024 09:11
@nicpuppa nicpuppa self-assigned this Jul 19, 2024
Copy link
Contributor

github-actions bot commented Jul 19, 2024

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

  • docs/apis-tools/java-client/index.md
  • docs/reference/announcements.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.

@nicpuppa nicpuppa marked this pull request as draft July 19, 2024 14:34
@christinaausley
Copy link
Contributor

@nicpuppa I see this is still in draft, is that because you have more changes coming, or this is most of it and you're ready for review? 😄

@nicpuppa
Copy link
Contributor Author

@nicpuppa I see this is still in draft, is that because you have more changes coming, or this is most of it and you're ready for review? 😄

Hey @christinaausley , I drafted this PR because we need to discuss if we took the right approach for the client. Later today I'm syncing with the team on this 🤞

@tmetzke
Copy link
Member

tmetzke commented Jul 29, 2024

As described in the latest decision, let's rewrite the announcement, stating that the Zeebe Client will be replaced by the more general Camunda Client with 8.7.

@nicpuppa nicpuppa changed the title docs(java-client): add announcement of java client restructure docs(java-client): add announcement of zeebe java client deprecation Jul 30, 2024
@nicpuppa nicpuppa requested a review from tmetzke July 30, 2024 08:51
Copy link
Member

@tmetzke tmetzke left a comment

Choose a reason for hiding this comment

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

The announcement in 8.6 will only be a heads-up for 8.7, so it should use the future tense. Plus, some things we don't know yet so let's not promise them.

docs/reference/announcements.md Outdated Show resolved Hide resolved
docs/reference/announcements.md Outdated Show resolved Hide resolved
docs/reference/announcements.md Outdated Show resolved Hide resolved
docs/reference/announcements.md Outdated Show resolved Hide resolved
docs/reference/announcements.md Outdated Show resolved Hide resolved
docs/reference/announcements.md Outdated Show resolved Hide resolved
docs/reference/announcements.md Outdated Show resolved Hide resolved
docs/reference/announcements.md Outdated Show resolved Hide resolved
docs/reference/announcements.md Outdated Show resolved Hide resolved
@nicpuppa
Copy link
Contributor Author

nicpuppa commented Jul 30, 2024

@tmetzke this is still the old PR 🤣 sorry for pinging you, I'm updating the announcement

@nicpuppa nicpuppa force-pushed the 4047-java-client-announcement branch from 856bcde to 98a39e6 Compare July 30, 2024 09:35
@nicpuppa nicpuppa marked this pull request as ready for review July 30, 2024 09:36
@nicpuppa nicpuppa requested a review from tmetzke July 30, 2024 09:36
@nicpuppa
Copy link
Contributor Author

Hey @christinaausley this PR is ready to be reviewed 👍

@christinaausley
Copy link
Contributor

Relates to camunda/camunda#19479.

@christinaausley
Copy link
Contributor

christinaausley commented Jul 31, 2024

Non-blocking, but would it be worth adding a brief note in https://docs.camunda.io/docs/apis-tools/java-client/ as well?

Looks like there are no "breaking" changes with this, but let me know if this changes 👍

@akeller
Copy link
Member

akeller commented Aug 1, 2024

@tmetzke @megglos can we get a review from either of you for this?

I also second what @christinaausley said.

Will we have a blog or forum content on this topic?

@tmetzke
Copy link
Member

tmetzke commented Aug 1, 2024

@tmetzke @megglos can we get a review from either of you for this?

I also second what @christinaausley said.

Will we have a blog or forum content on this topic?

A heads-up note there that this will become the Camunda Client with 8.7 would be nice, I agree, good idea, @christinaausley 👍
It can link back to the announcement for further information.

No blog or forum post planned so far. A blog entry is too much here for the change from Zeebe Client to Camunda Client. Regarding the overall theme for 8.7 from component REST APIs to one consolidated C8 REST API and accordingly from component clients to one consolidated Camunda Client would definitely be worth a blog post. /cc @aleksander-dytko for visibility, not sure if anything is already planned in that direction.

@nicpuppa nicpuppa force-pushed the 4047-java-client-announcement branch from fc2171e to efd3724 Compare August 2, 2024 04:54
@nicpuppa
Copy link
Contributor Author

nicpuppa commented Aug 2, 2024

Hey @christinaausley @tmetzke I wrote an heads up as suggested, please have a look 💪

tmetzke
tmetzke previously approved these changes Aug 2, 2024
Copy link
Member

@tmetzke tmetzke left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me 🚀

MaxTru
MaxTru previously approved these changes Aug 2, 2024
@christinaausley christinaausley dismissed stale reviews from MaxTru and tmetzke via aa72f90 August 2, 2024 14:29
@christinaausley
Copy link
Contributor

🚀

@nicpuppa nicpuppa merged commit 70431bc into main Aug 2, 2024
7 checks passed
@nicpuppa nicpuppa deleted the 4047-java-client-announcement branch August 2, 2024 23:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
target:8.6 Issues included in the 8.6 release
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Add an announcement related to the java client changes
5 participants