Announce Go client & zbctl deprecation (#4264)

* Announce Go client & zbctl deprecation * Improved wording on zeebe go client deprecation announcement Co-authored-by: Mark Sellings <[email protected]> * Improved language on Go client deprecation announcement Co-authored-by: Mark Sellings <[email protected]> * Add deprecation announcement to all go-client pages * Revised lang on go client deprecation announcement Co-authored-by: Aleksander Dytko <[email protected]> --------- Co-authored-by: Mark Sellings <[email protected]> Co-authored-by: Aleksander Dytko <[email protected]>
camunda · Sep 6, 2024 · c06f89b · c06f89b
1 parent ccca3bd
commit c06f89b
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 19 deletions.
diff --git a/docs/apis-tools/go-client/go-get-started.md b/docs/apis-tools/go-client/go-get-started.md
@@ -7,6 +7,12 @@ sidebar_label: "Getting started with the Go client"
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
+:::caution
+
+The Zeebe Go client will be officially deprecated with the 8.6 release. For more information, see [announcements](../../../reference/announcements/#deprecation-zeebe-go-client--zbctl).
+
+:::
+
 In this tutorial, you will learn how to use the Go client in a Go application to interact with Camunda 8.
 
 You can find a complete example on [GitHub](https://github.com/camunda/camunda-platform-get-started/tree/main/go).

diff --git a/docs/apis-tools/go-client/index.md b/docs/apis-tools/go-client/index.md
@@ -1,10 +1,16 @@
 ---
 id: index
-title: "Go client"
+title: "Go client (Deprecated)"
 sidebar_label: "Quick reference"
 description: "Instantiate the client by passing in the address of the cluster you want to connect to in a Go application to interact with Camunda 8."
 ---
 
+:::caution
+
+The Zeebe Go client will be officially deprecated with the 8.6 release. For more information, see [announcements](../../reference/announcements/#deprecation-zeebe-go-client--zbctl).
+
+:::
+
 ## Dependencies
 
 To use the [Zeebe Go client library](https://github.com/camunda/camunda-platform-get-started/tree/main/go), add the following dependency to your `go.mod`:

diff --git a/docs/apis-tools/go-client/job-worker.md b/docs/apis-tools/go-client/job-worker.md
@@ -5,6 +5,12 @@ description: "Let's take a deeper look at job workers to handle jobs."
 keywords: ["backpressure", "back-pressure", "back pressure"]
 ---
 
+:::caution
+
+The Zeebe Go client will be officially deprecated with the 8.6 release. For more information, see [announcements](../../../reference/announcements/#deprecation-zeebe-go-client--zbctl).
+
+:::
+
 The Go client provides a job worker that handles both polling and streaming for available jobs. This allows you to focus on writing code to handle the activated jobs.
 
 On `Open`, the job worker waits `PollInterval` milliseconds and then polls for `MaxJobsActive` jobs. It then continues with the following schedule:

diff --git a/docs/reference/announcements.md b/docs/reference/announcements.md
@@ -50,6 +50,10 @@ The Zeebe Java client will not be developed further and will only receive bug fi
 - **Artifact ID change**:
   - The `artifactId` will change from `zeebe-client-java` to `camunda-client-java`.
 
+### Deprecation: Zeebe Go client & zbctl
+
+The Zeebe Go Client and zbctl will be officially deprecated with the 8.6 release as part of our efforts to streamline the Camunda 8 API experience. This client and CLI utility will not get released starting with Camunda 8.6, will no longer receive new features, and will be transitioned to a community-maintained status.
+
 ### Camunda 8 SaaS - Required cluster update
 
 :::caution
@@ -77,23 +81,6 @@ If you do not update the cluster by August 30th 2024, we will update the cluster
 
 Camunda 8 Self-Managed clusters are not affected by this.
 
-### Zeebe repo rename impacts Go client
-
-The Camunda 8 Github repository was renamed from `http://github.com/camunda/zeebe` to `http://github.com/camunda/camunda`, impacting the Zeebe Go client path.
-
-Starting in 8.6.0, the Zeebe Go client path should reflect the renamed repo as follows:
-
-```go
-
-module example.com/mymodule
-
-require (
-    github.com/camunda/camunda/clients/go/v8 v8.x.y
-    ...
-)
-
-```
-
 ### Supported environment changes (OpenJDK, ElasticSearch, Amazon OpenSearch)
 
 Version changes are made to supported environments:

diff --git a/sidebars.js b/sidebars.js
@@ -802,7 +802,7 @@ module.exports = {
           ],
         },
         {
-          "Go client": [
+          "Go client (Deprecated)": [
             "apis-tools/go-client/index",
             "apis-tools/go-client/go-get-started",
             "apis-tools/go-client/job-worker",