diff --git a/docs/guides/getting-started-java-spring.md b/docs/guides/getting-started-java-spring.md index 70bb9708e4..f8c01e3e43 100644 --- a/docs/guides/getting-started-java-spring.md +++ b/docs/guides/getting-started-java-spring.md @@ -7,12 +7,16 @@ keywords: [java, spring, spring zeebe, getting started, user guide, tutorial] --- import SmPrereqs from './react-components/sm-prerequisites.md' -import Install from './react-components/install-docker-compose.md' +import Install from './react-components/install-plain-java.md' Beginner 1 hour

-In this guide, we'll step through using Spring Boot and the [Spring Zeebe SDK](/apis-tools/spring-zeebe-sdk/getting-started.md) with Desktop Modeler to interact with your local Self-Managed Camunda 8 installation. +:::note +This tutorial is not intended for production purposes. +::: + +In this guide, we'll step through using Spring Boot and the [Spring Zeebe SDK](/apis-tools/spring-zeebe-sdk/getting-started.md) with Desktop Modeler to interact with your local Self-Managed Camunda 8 installation. You can also follow this guide with SaaS and Web Modeler after you [create an account](https://signup.camunda.com/accounts?utm_source=docs.camunda.io&utm_medium=referral). By the end of this tutorial, you'll be able to use Spring and Java code with Zeebe to: @@ -24,12 +28,10 @@ For example, in this guide we will outline a BPMN model to receive a payment req ![example BPMN model to receive a payment request, prepare a transaction, charge a credit card, and execute a payment](./img/prepare-transaction-example.png) -:::note -This tutorial is not intended for production purposes. -::: - +## Step 1: Install Camunda 8 Self-Managed + ## Step 2: Create a new Spring Boot project diff --git a/docs/guides/getting-started-orchestrate-apis.md b/docs/guides/getting-started-orchestrate-apis.md index 793c82e97d..3c42a33119 100644 --- a/docs/guides/getting-started-orchestrate-apis.md +++ b/docs/guides/getting-started-orchestrate-apis.md @@ -11,22 +11,37 @@ keywords: Time estimate: 15 minutes

import clsx from "clsx"; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import SmPrereqs from './react-components/sm-prerequisites.md' +import SaasPrereqs from './react-components/saas-prerequisites.md' import Install from './react-components/install-plain-java.md' -
- Have you installed Camunda yet? - -
- This guide will walk you through working with a REST Connector task as a first time Camunda 8 user. The REST Connector is a [protocol Connector](/components/connectors/out-of-the-box-connectors/available-connectors-overview.md#protocol-connectors), where you can make a request to a REST API and use the response in the next steps of your process. :::note New to Connectors? Review our [introduction to Connectors](/components/connectors/introduction.md) to get familiar with their capabilities, and have a closer look at all of the available [out-of-the-box Connectors](/components/connectors/out-of-the-box-connectors/available-connectors-overview.md). ::: + + +
+ Have you installed Camunda yet? + + +
+ + +
+ Have you signed up for Camunda yet? + +
+ + + The concept of a Connector consists of two parts: the business logic is implemented as a job worker, and the user interface during modeling is provided using an element template. In this guide, you will create a REST Connector task in your process, handle the HTTP response, and deploy your process. New to creating a process? Get started by [modeling your first diagram](/guides/model-your-first-process.md). -## Create a REST Connector task +## Step 1: Create a REST Connector task To use a **REST Connector** in your process, follow the steps below: @@ -40,18 +55,18 @@ To use a **REST Connector** in your process, follow the steps below: 6. Add a descriptive name using the **General** section in the properties panel. For this guide, we'll use `Make a request`. -## Make your REST Connector executable +## Step 2: Make your REST Connector executable ![Connector on Web Modeler canvas with properties panel open](img/connectors-rest-red-properties.png) To make the **REST Connector** executable, fill out the mandatory **URL** field in the HTTP Endpoint section (highlighted in red) in the properties panel with `https://catfact.ninja/fact` so we can get a random cat fact from the [Cat Fact API](https://catfact.ninja/) for this example. -## Handle your response +## Step 3: Handle your response The HTTP response will be available in a temporary local response variable. This variable can be mapped to the process by specifying **Result Variable**. In the **Response Mapping** section use `={"body" : body}` as the **Result Expression** so you can see the entire JSON object returned if it's successful. -## Deploy your process +## Step 4: Deploy your process To deploy your process, take the following steps: @@ -86,7 +101,7 @@ Don't want to build the process yourself? Click this button to create it from a href="https://signup.camunda.com/accounts?utm_source=docs.camunda.io&utm_medium=referral"> Sign up - +
## Additional resources and next steps diff --git a/docs/guides/getting-started-orchestrate-human-tasks.md b/docs/guides/getting-started-orchestrate-human-tasks.md index b24b1301c1..da54e58fc7 100644 --- a/docs/guides/getting-started-orchestrate-human-tasks.md +++ b/docs/guides/getting-started-orchestrate-human-tasks.md @@ -22,22 +22,36 @@ import FormEditorImg from './img/form-editor.png'; import NavigationHistoryImg from './img/modeler-navigation-history.png'; import clsx from "clsx"; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; import SmPrereqs from './react-components/sm-prerequisites.md' +import SaasPrereqs from './react-components/saas-prerequisites.md' import Install from './react-components/install-plain-java.md' -
- Have you installed Camunda yet? - -
- Camunda 8 allows you to orchestrate processes with human tasks of any complexity. Utilizing user tasks, you can create and assign tasks to users. Then, users can perform their work and enter the necessary data to drive the business process. -This guide introduces you to the basics of human task orchestration. You will create a simple process to decide on dinner, and drive the process flow according to that decision. This process is entirely executable in the browser. - :::note If you prefer a video-based learning experience or a more complex example, visit [this Camunda Academy course](https://bit.ly/3PJJocB). ::: +This guide introduces you to the basics of human task orchestration. You will create a simple process to decide on dinner, and drive the process flow according to that decision. This process is entirely executable in the browser. + + + +
+ Have you installed Camunda yet? + + +
+ + +
+ Have you signed up for Camunda yet? + +
+ + + Take the following five steps to create and run your first process with a human in the loop: ### Step 1: Create a new process @@ -217,7 +231,7 @@ Don't want to build the process yourself? Click this button to create it from a href="https://signup.camunda.com/accounts?utm_source=docs.camunda.io&utm_medium=referral"> Sign up - +
## Additional resources and next steps diff --git a/docs/guides/getting-started-orchestrate-microservices.md b/docs/guides/getting-started-orchestrate-microservices.md index 336800e94f..123702b3ba 100644 --- a/docs/guides/getting-started-orchestrate-microservices.md +++ b/docs/guides/getting-started-orchestrate-microservices.md @@ -15,7 +15,7 @@ import TabItem from '@theme/TabItem'; import CreateCluster from '../components/react-components/create-cluster.md'; import SmPrereqs from './react-components/sm-prerequisites.md' import SaasPrereqs from './react-components/saas-prerequisites.md' -import Install from './react-components/install-docker-compose.md' +import Install from './react-components/install-plain-java.md' Using Camunda 8, you can orchestrate the microservices necessary to achieve your end-to-end automated business process. Whether you have existing microservices or are looking to build out your microservices, this guide will help you understand how you can start your microservice orchestration journey with Camunda 8. @@ -48,7 +48,7 @@ Additionally, you need the following: - IDE (IntelliJ, VSCode, or similar) - Download and unzip or clone the [repo](https://github.com/camunda/camunda-platform-tutorials), then `cd` into `camunda-platform-tutorials/orchestrate-microservices/worker-java` -### Design your process with BPMN +## Step 1: Design your process with BPMN Start by designing your automated process using BPMN. This guide introduces you to the palette and a few BPMN symbols in Web Modeler. @@ -67,11 +67,11 @@ Start by designing your automated process using BPMN. This guide introduces you 9. Start a new process instance by clicking on the blue **Run** button. 10. In the top left corner of the screen, click the square-shaped **Camunda components** button. Navigate to Operate to see your process instance with a token waiting at the service task by clicking **View process instances**. -### Create a cluster +## Step 2: Create a cluster -### Create credentials for your Zeebe client +## Step 3: Create credentials for your Zeebe client To interact with your Camunda 8 cluster, you'll use the Zeebe client. First, you'll need to create credentials. @@ -83,7 +83,7 @@ To interact with your Camunda 8 cluster, you'll use the Zeebe client. First, you 3. Provide a descriptive name for your client like `microservice-worker`. For this tutorial, the scope can be the default Zeebe scope. Click **Create**. 4. Your client credentials can be copied or downloaded at this point. You will need your client id and your client secret when creating a worker in the next section, so keep this window open. Once you close or navigate away from this screen, you will not be able to see them again. -### Create a worker for the service task +## Step 4: Create a worker for the service task Next, we’ll create a worker for the service task by associating it with the type we specified on the service task in the BPMN diagram. @@ -116,7 +116,7 @@ Don't want to build the process yourself? Click this button to create it from a href="https://signup.camunda.com/accounts?utm_source=docs.camunda.io&utm_medium=referral"> Sign up - +
## Additional resources and next steps diff --git a/docs/guides/react-components/install-plain-java.md b/docs/guides/react-components/install-plain-java.md index 4de7c5e430..fc4616ce2e 100644 --- a/docs/guides/react-components/install-plain-java.md +++ b/docs/guides/react-components/install-plain-java.md @@ -1,14 +1,12 @@ --- --- -## Step 1: Install Camunda 8 Self-Managed - **Starting in 8.6.0-alpha2**, you can install Camunda 8 Self-Managed as an integrated plain Java application. For this installation, you must have: -- JDK 21+ locally installed -- Camunda 8.6.0-alpha2 or later +- OpenJDK 21+ locally installed +- Camunda `8.6.0-alpha2` or later 1. Download the [latest release artifact](https://github.com/camunda/camunda/releases), starting with [8.6.0-alpha2](https://github.com/camunda/camunda/releases/tag/8.6.0-alpha2). 2. Download [Elasticsearch 8.9.2](https://www.elastic.co/downloads/past-releases/elasticsearch-8-9-2) diff --git a/docs/guides/react-components/sm-prerequisites.md b/docs/guides/react-components/sm-prerequisites.md index 0b9ff8f631..aa374b7cb4 100644 --- a/docs/guides/react-components/sm-prerequisites.md +++ b/docs/guides/react-components/sm-prerequisites.md @@ -6,6 +6,4 @@ Before getting started, ensure you: - Can access your preferred code editor or IDE. -- Have Java [installed locally](https://www.java.com/en/download/). Currently, the Spring Initializr supports Java versions 17, 21, and 22. -- Have [Docker Desktop](https://www.docker.com/products/docker-desktop/) installed locally. - Install [Desktop Modeler](https://camunda.com/download/modeler/). diff --git a/sidebars.js b/sidebars.js index 33b18a7604..9b6a784572 100644 --- a/sidebars.js +++ b/sidebars.js @@ -14,7 +14,7 @@ module.exports = { "guides/getting-started-java-spring", "guides/model-your-first-process", { - "Use cases": [ + "By use case": [ "guides/orchestrate-human-tasks", "guides/orchestrate-apis", "guides/orchestrate-microservices", diff --git a/src/pages/meta.md b/src/pages/meta.md index c1eb6df61c..61aca20c81 100644 --- a/src/pages/meta.md +++ b/src/pages/meta.md @@ -3,7 +3,9 @@ title: How to use the docs description: Learn how Camunda 8 docs are structured and what you can expect when using the docs --- -# How to use the docs +::: +Our docs are changing! You will see more SaaS and Self-Managed content side-by-side, starting with our Guides section. +::: [docs.camunda.io](https://docs.camunda.io) is home to the Camunda 8 docs, including all of the components.