From 9f1a66d82c4da467d9a7be2a931c000bd4754b45 Mon Sep 17 00:00:00 2001 From: mesellings Date: Wed, 9 Oct 2024 09:08:06 +0100 Subject: [PATCH 1/6] Fix link format and typo --- docs/guides/getting-started-java-spring.md | 2 +- docs/guides/react-components/install-c8run.md | 2 +- docs/self-managed/setup/deploy/local/c8run.md | 2 +- .../self-managed/setup/deploy/local/local-kubernetes-cluster.md | 2 +- .../self-managed/setup/deploy/local/local-kubernetes-cluster.md | 2 +- .../version-8.6/guides/getting-started-java-spring.md | 2 +- .../version-8.6/guides/react-components/install-c8run.md | 2 +- .../version-8.6/self-managed/setup/deploy/local/c8run.md | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/guides/getting-started-java-spring.md b/docs/guides/getting-started-java-spring.md index c56f209938..6e43feeb9b 100644 --- a/docs/guides/getting-started-java-spring.md +++ b/docs/guides/getting-started-java-spring.md @@ -133,7 +133,7 @@ See our documentation on [adding the Spring Zeebe SDK to your project](/apis-too ``` -2. Add the following dependency your `pom.xml` file, as a child of the `` element: +2. Add the following dependency to your `pom.xml` file, as a child of the `` element: :::warning Due to a bug in 8.6, use the Spring Zeebe SDK version `8.5.0`. diff --git a/docs/guides/react-components/install-c8run.md b/docs/guides/react-components/install-c8run.md index 0a7b36e662..a0aef9bb7a 100644 --- a/docs/guides/react-components/install-c8run.md +++ b/docs/guides/react-components/install-c8run.md @@ -1,7 +1,7 @@ ### Prerequisites :::warning -Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs included in Camunda 8 Run. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api//authentication.md#authentication-via-cookie-self-managed-only). +Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs included in Camunda 8 Run. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only). ::: - OpenJDK 21+ diff --git a/docs/self-managed/setup/deploy/local/c8run.md b/docs/self-managed/setup/deploy/local/c8run.md index 5844f5c0eb..7f2c42a157 100644 --- a/docs/self-managed/setup/deploy/local/c8run.md +++ b/docs/self-managed/setup/deploy/local/c8run.md @@ -26,7 +26,7 @@ Camunda 8 Run includes the following: ## Prerequisites :::warning -Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs included in Camunda 8 Run. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api//authentication.md#authentication-via-cookie-self-managed-only). +Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs included in Camunda 8 Run. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only). ::: - OpenJDK 21+ diff --git a/docs/self-managed/setup/deploy/local/local-kubernetes-cluster.md b/docs/self-managed/setup/deploy/local/local-kubernetes-cluster.md index 1c3ef0102e..2f6d92c316 100644 --- a/docs/self-managed/setup/deploy/local/local-kubernetes-cluster.md +++ b/docs/self-managed/setup/deploy/local/local-kubernetes-cluster.md @@ -72,7 +72,7 @@ Depending on your machine hardware and internet connection speed, the services m ## Connecting to Camunda 8 components :::warning -Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api//authentication.md#authentication-via-cookie-self-managed-only). +Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only). ::: Camunda services deployed in a Kubernetes cluster are not accessible from outside the cluster. To connect to your Camunda 8 cluster, use either port-forwarding or Kubernetes Ingress. diff --git a/versioned_docs/version-8.5/self-managed/setup/deploy/local/local-kubernetes-cluster.md b/versioned_docs/version-8.5/self-managed/setup/deploy/local/local-kubernetes-cluster.md index 519589702a..8f6928d859 100644 --- a/versioned_docs/version-8.5/self-managed/setup/deploy/local/local-kubernetes-cluster.md +++ b/versioned_docs/version-8.5/self-managed/setup/deploy/local/local-kubernetes-cluster.md @@ -72,7 +72,7 @@ Depending on your machine hardware and internet connection speed, the services m ## Connecting to Camunda 8 components :::warning -Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api//authentication.md#authentication-via-cookie-self-managed-only). +Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only). ::: Camunda services deployed in a Kubernetes cluster are not accessible from outside the cluster. To connect to your Camunda 8 cluster, use either port-forwarding or Kubernetes Ingress. diff --git a/versioned_docs/version-8.6/guides/getting-started-java-spring.md b/versioned_docs/version-8.6/guides/getting-started-java-spring.md index a26747edc6..e35411e9b9 100644 --- a/versioned_docs/version-8.6/guides/getting-started-java-spring.md +++ b/versioned_docs/version-8.6/guides/getting-started-java-spring.md @@ -133,7 +133,7 @@ See our documentation on [adding the Spring Zeebe SDK to your project](/apis-too ``` -2. Add the following dependency your `pom.xml` file, as a child of the `` element: +2. Add the following dependency to your `pom.xml` file, as a child of the `` element: :::warning Due to a bug in 8.6, use the Spring Zeebe SDK version `8.5.0`. diff --git a/versioned_docs/version-8.6/guides/react-components/install-c8run.md b/versioned_docs/version-8.6/guides/react-components/install-c8run.md index 0a7b36e662..a0aef9bb7a 100644 --- a/versioned_docs/version-8.6/guides/react-components/install-c8run.md +++ b/versioned_docs/version-8.6/guides/react-components/install-c8run.md @@ -1,7 +1,7 @@ ### Prerequisites :::warning -Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs included in Camunda 8 Run. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api//authentication.md#authentication-via-cookie-self-managed-only). +Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs included in Camunda 8 Run. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only). ::: - OpenJDK 21+ diff --git a/versioned_docs/version-8.6/self-managed/setup/deploy/local/c8run.md b/versioned_docs/version-8.6/self-managed/setup/deploy/local/c8run.md index 5844f5c0eb..7f2c42a157 100644 --- a/versioned_docs/version-8.6/self-managed/setup/deploy/local/c8run.md +++ b/versioned_docs/version-8.6/self-managed/setup/deploy/local/c8run.md @@ -26,7 +26,7 @@ Camunda 8 Run includes the following: ## Prerequisites :::warning -Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs included in Camunda 8 Run. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api//authentication.md#authentication-via-cookie-self-managed-only). +Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs included in Camunda 8 Run. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only). ::: - OpenJDK 21+ From a9bd8f72f02ec5d209e99a9bdc770d16e04bb47f Mon Sep 17 00:00:00 2001 From: mesellings Date: Wed, 9 Oct 2024 09:19:47 +0100 Subject: [PATCH 2/6] Remove warning from k8s --- .../setup/deploy/local/local-kubernetes-cluster.md | 4 ---- .../setup/deploy/local/local-kubernetes-cluster.md | 4 ---- 2 files changed, 8 deletions(-) diff --git a/docs/self-managed/setup/deploy/local/local-kubernetes-cluster.md b/docs/self-managed/setup/deploy/local/local-kubernetes-cluster.md index 2f6d92c316..158da8cc6f 100644 --- a/docs/self-managed/setup/deploy/local/local-kubernetes-cluster.md +++ b/docs/self-managed/setup/deploy/local/local-kubernetes-cluster.md @@ -71,10 +71,6 @@ Depending on your machine hardware and internet connection speed, the services m ## Connecting to Camunda 8 components -:::warning -Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only). -::: - Camunda services deployed in a Kubernetes cluster are not accessible from outside the cluster. To connect to your Camunda 8 cluster, use either port-forwarding or Kubernetes Ingress. :::note diff --git a/versioned_docs/version-8.5/self-managed/setup/deploy/local/local-kubernetes-cluster.md b/versioned_docs/version-8.5/self-managed/setup/deploy/local/local-kubernetes-cluster.md index 8f6928d859..fdea486300 100644 --- a/versioned_docs/version-8.5/self-managed/setup/deploy/local/local-kubernetes-cluster.md +++ b/versioned_docs/version-8.5/self-managed/setup/deploy/local/local-kubernetes-cluster.md @@ -71,10 +71,6 @@ Depending on your machine hardware and internet connection speed, the services m ## Connecting to Camunda 8 components -:::warning -Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only). -::: - Camunda services deployed in a Kubernetes cluster are not accessible from outside the cluster. To connect to your Camunda 8 cluster, use either port-forwarding or Kubernetes Ingress. :::note From bdd89f7a5e869cb47ddff299489f1f8406b96d03 Mon Sep 17 00:00:00 2001 From: mesellings Date: Wed, 9 Oct 2024 10:01:00 +0100 Subject: [PATCH 3/6] Edit cookie auth warning --- docs/guides/react-components/install-c8run.md | 4 ++-- docs/self-managed/setup/deploy/local/c8run.md | 4 ++-- .../version-8.6/guides/react-components/install-c8run.md | 4 ++-- .../version-8.6/self-managed/setup/deploy/local/c8run.md | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/guides/react-components/install-c8run.md b/docs/guides/react-components/install-c8run.md index a0aef9bb7a..cdc0651c2c 100644 --- a/docs/guides/react-components/install-c8run.md +++ b/docs/guides/react-components/install-c8run.md @@ -1,7 +1,7 @@ ### Prerequisites -:::warning -Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs included in Camunda 8 Run. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only). +:::caution +Cookie authentication is required to use the Camunda 8 REST API included in Camunda 8 Run. For an example of cookie authentication, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only). ::: - OpenJDK 21+ diff --git a/docs/self-managed/setup/deploy/local/c8run.md b/docs/self-managed/setup/deploy/local/c8run.md index 7f2c42a157..9bb01a3bf4 100644 --- a/docs/self-managed/setup/deploy/local/c8run.md +++ b/docs/self-managed/setup/deploy/local/c8run.md @@ -25,8 +25,8 @@ Camunda 8 Run includes the following: ## Prerequisites -:::warning -Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs included in Camunda 8 Run. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only). +:::caution +Cookie authentication is required to use the Camunda 8 REST API included in Camunda 8 Run. For an example of cookie authentication, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only). ::: - OpenJDK 21+ diff --git a/versioned_docs/version-8.6/guides/react-components/install-c8run.md b/versioned_docs/version-8.6/guides/react-components/install-c8run.md index a0aef9bb7a..cdc0651c2c 100644 --- a/versioned_docs/version-8.6/guides/react-components/install-c8run.md +++ b/versioned_docs/version-8.6/guides/react-components/install-c8run.md @@ -1,7 +1,7 @@ ### Prerequisites -:::warning -Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs included in Camunda 8 Run. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only). +:::caution +Cookie authentication is required to use the Camunda 8 REST API included in Camunda 8 Run. For an example of cookie authentication, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only). ::: - OpenJDK 21+ diff --git a/versioned_docs/version-8.6/self-managed/setup/deploy/local/c8run.md b/versioned_docs/version-8.6/self-managed/setup/deploy/local/c8run.md index 7f2c42a157..9bb01a3bf4 100644 --- a/versioned_docs/version-8.6/self-managed/setup/deploy/local/c8run.md +++ b/versioned_docs/version-8.6/self-managed/setup/deploy/local/c8run.md @@ -25,8 +25,8 @@ Camunda 8 Run includes the following: ## Prerequisites -:::warning -Due to a bug in 8.6, cookie authentication is required to use the Tasklist, Operate, and Zeebe APIs included in Camunda 8 Run. For an example of authenticating via cookie, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only). +:::caution +Cookie authentication is required to use the Camunda 8 REST API included in Camunda 8 Run. For an example of cookie authentication, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only). ::: - OpenJDK 21+ From ea1064160d570c476da22ffe02abb57c40ec41db Mon Sep 17 00:00:00 2001 From: Amara Graham Date: Wed, 9 Oct 2024 09:00:51 -0500 Subject: [PATCH 4/6] soften warning to caution --- docs/guides/getting-started-java-spring.md | 2 +- .../version-8.6/guides/getting-started-java-spring.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/getting-started-java-spring.md b/docs/guides/getting-started-java-spring.md index 6e43feeb9b..8c6b4e8533 100644 --- a/docs/guides/getting-started-java-spring.md +++ b/docs/guides/getting-started-java-spring.md @@ -135,7 +135,7 @@ See our documentation on [adding the Spring Zeebe SDK to your project](/apis-too 2. Add the following dependency to your `pom.xml` file, as a child of the `` element: -:::warning +:::caution Due to a bug in 8.6, use the Spring Zeebe SDK version `8.5.0`. ::: diff --git a/versioned_docs/version-8.6/guides/getting-started-java-spring.md b/versioned_docs/version-8.6/guides/getting-started-java-spring.md index e35411e9b9..c963e5ba20 100644 --- a/versioned_docs/version-8.6/guides/getting-started-java-spring.md +++ b/versioned_docs/version-8.6/guides/getting-started-java-spring.md @@ -135,7 +135,7 @@ See our documentation on [adding the Spring Zeebe SDK to your project](/apis-too 2. Add the following dependency to your `pom.xml` file, as a child of the `` element: -:::warning +:::caution Due to a bug in 8.6, use the Spring Zeebe SDK version `8.5.0`. ::: From 747612dd0d03a939acd3e1d826a10a65fa8f441d Mon Sep 17 00:00:00 2001 From: Cole Garbo Date: Wed, 9 Oct 2024 10:33:34 -0400 Subject: [PATCH 5/6] remove pinned 8.5 version from spring guide --- docs/guides/getting-started-java-spring.md | 4 ---- .../version-8.6/guides/getting-started-java-spring.md | 4 ---- 2 files changed, 8 deletions(-) diff --git a/docs/guides/getting-started-java-spring.md b/docs/guides/getting-started-java-spring.md index 8c6b4e8533..a7cf3d66d3 100644 --- a/docs/guides/getting-started-java-spring.md +++ b/docs/guides/getting-started-java-spring.md @@ -135,10 +135,6 @@ See our documentation on [adding the Spring Zeebe SDK to your project](/apis-too 2. Add the following dependency to your `pom.xml` file, as a child of the `` element: -:::caution -Due to a bug in 8.6, use the Spring Zeebe SDK version `8.5.0`. -::: - ``` io.camunda diff --git a/versioned_docs/version-8.6/guides/getting-started-java-spring.md b/versioned_docs/version-8.6/guides/getting-started-java-spring.md index c963e5ba20..7612218dd5 100644 --- a/versioned_docs/version-8.6/guides/getting-started-java-spring.md +++ b/versioned_docs/version-8.6/guides/getting-started-java-spring.md @@ -135,10 +135,6 @@ See our documentation on [adding the Spring Zeebe SDK to your project](/apis-too 2. Add the following dependency to your `pom.xml` file, as a child of the `` element: -:::caution -Due to a bug in 8.6, use the Spring Zeebe SDK version `8.5.0`. -::: - ``` io.camunda From 7f6da51e5c91b456cacced8a33e57b639b09ba25 Mon Sep 17 00:00:00 2001 From: Cole Garbo Date: Wed, 9 Oct 2024 10:49:44 -0400 Subject: [PATCH 6/6] remove warning, include as optional prereq --- docs/guides/react-components/install-c8run.md | 6 ++---- docs/self-managed/setup/deploy/local/c8run.md | 6 ++---- .../version-8.6/guides/react-components/install-c8run.md | 6 ++---- .../version-8.6/self-managed/setup/deploy/local/c8run.md | 6 ++---- 4 files changed, 8 insertions(+), 16 deletions(-) diff --git a/docs/guides/react-components/install-c8run.md b/docs/guides/react-components/install-c8run.md index cdc0651c2c..823b344b38 100644 --- a/docs/guides/react-components/install-c8run.md +++ b/docs/guides/react-components/install-c8run.md @@ -1,12 +1,10 @@ ### Prerequisites -:::caution -Cookie authentication is required to use the Camunda 8 REST API included in Camunda 8 Run. For an example of cookie authentication, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only). -::: - - OpenJDK 21+ - [Desktop Modeler](/components/modeler/desktop-modeler/install-the-modeler.md) +To use Camunda 8 Run with the Camunda REST API, cookie authentication is also required. See the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only) for an example of cookie authentication. + :::note After installing OpenJDK, ensure `JAVA_HOME` is set by running `java -version` in a **new** terminal. diff --git a/docs/self-managed/setup/deploy/local/c8run.md b/docs/self-managed/setup/deploy/local/c8run.md index 9bb01a3bf4..de1b973480 100644 --- a/docs/self-managed/setup/deploy/local/c8run.md +++ b/docs/self-managed/setup/deploy/local/c8run.md @@ -25,13 +25,11 @@ Camunda 8 Run includes the following: ## Prerequisites -:::caution -Cookie authentication is required to use the Camunda 8 REST API included in Camunda 8 Run. For an example of cookie authentication, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only). -::: - - OpenJDK 21+ - [Desktop Modeler](/components/modeler/desktop-modeler/install-the-modeler.md) +To use Camunda 8 Run with the Camunda REST API, cookie authentication is also required. See the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only) for an example of cookie authentication. + :::note After installing OpenJDK, ensure `JAVA_HOME` is set by running `java -version` in a **new** terminal. diff --git a/versioned_docs/version-8.6/guides/react-components/install-c8run.md b/versioned_docs/version-8.6/guides/react-components/install-c8run.md index cdc0651c2c..823b344b38 100644 --- a/versioned_docs/version-8.6/guides/react-components/install-c8run.md +++ b/versioned_docs/version-8.6/guides/react-components/install-c8run.md @@ -1,12 +1,10 @@ ### Prerequisites -:::caution -Cookie authentication is required to use the Camunda 8 REST API included in Camunda 8 Run. For an example of cookie authentication, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only). -::: - - OpenJDK 21+ - [Desktop Modeler](/components/modeler/desktop-modeler/install-the-modeler.md) +To use Camunda 8 Run with the Camunda REST API, cookie authentication is also required. See the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only) for an example of cookie authentication. + :::note After installing OpenJDK, ensure `JAVA_HOME` is set by running `java -version` in a **new** terminal. diff --git a/versioned_docs/version-8.6/self-managed/setup/deploy/local/c8run.md b/versioned_docs/version-8.6/self-managed/setup/deploy/local/c8run.md index 9bb01a3bf4..de1b973480 100644 --- a/versioned_docs/version-8.6/self-managed/setup/deploy/local/c8run.md +++ b/versioned_docs/version-8.6/self-managed/setup/deploy/local/c8run.md @@ -25,13 +25,11 @@ Camunda 8 Run includes the following: ## Prerequisites -:::caution -Cookie authentication is required to use the Camunda 8 REST API included in Camunda 8 Run. For an example of cookie authentication, see the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only). -::: - - OpenJDK 21+ - [Desktop Modeler](/components/modeler/desktop-modeler/install-the-modeler.md) +To use Camunda 8 Run with the Camunda REST API, cookie authentication is also required. See the [Operate API documentation](/apis-tools/operate-api/authentication.md#authentication-via-cookie-self-managed-only) for an example of cookie authentication. + :::note After installing OpenJDK, ensure `JAVA_HOME` is set by running `java -version` in a **new** terminal.