Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
akeller committed Jun 26, 2024
1 parent d7acabd commit 6fccb2a
Show file tree
Hide file tree
Showing 14 changed files with 149 additions and 42 deletions.
27 changes: 8 additions & 19 deletions docs/guides/getting-started-java-spring.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
---
id: getting-started-java-spring
title: Getting started as a Java developer using Spring
sidebar_label: Getting started as a Java developer using Spring
title: Get started as a Java developer using Spring
sidebar_label: Get started with Spring
description: "Use Spring Boot and the Spring Zeebe SDK to interact with your local Self-Managed Camunda 8 installation."
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'

<span class="badge badge--beginner">Beginner</span>
<span class="badge badge--medium">1 hour</span>
<span class="badge badge--medium">1 hour</span><br /><br />

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.

Expand All @@ -25,23 +28,9 @@ For example, in this guide we will outline a BPMN model to receive a payment req
This tutorial is not intended for production purposes.
:::

## Prerequisites

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

## Step 1: Install Camunda 8 Self-Managed

If you haven't already, follow [this guide](/self-managed/setup/deploy/local/docker-compose.md) to install Camunda 8 Self-Managed locally via Docker Compose:

1. Use the `docker-compose.yaml` file in [this repository](https://github.com/camunda/camunda-platform).
2. Clone this repo and run `docker compose up -d` in your terminal to start your environment.
<SmPrereqs/>

To confirm Camunda 8 Self-Managed is installed, click into Docker Desktop. Here, you will see the `camunda-platform` container. Alternatively, navigate to the different components and log in with the username `demo` and password `demo`. For example, Operate can be accessed at [http://localhost:8081](http://localhost:8081) (as noted under **Port(s)** in the Docker container). Find additional guidance in the repository [README](https://github.com/camunda/camunda-platform?tab=readme-ov-file#using-docker-compose).
<Install/>

## Step 2: Create a new Spring Boot project

Expand Down
14 changes: 11 additions & 3 deletions docs/guides/getting-started-orchestrate-apis.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@
---
id: orchestrate-apis
title: Getting started with API orchestration
sidebar_label: Getting started with API orchestration
title: Get started with API orchestration
sidebar_label: Get started with API orchestration
description: "Use Connectors to build low code process automation solutions"
keywords:
[api endpoints, orchestration, getting started, user guide, connectors]
---

<span class="badge badge--beginner">Beginner</span>
<span class="badge badge--medium">Time estimate: 15 minutes</span>
<span class="badge badge--medium">Time estimate: 15 minutes</span><br /><br />

import clsx from "clsx";
import SmPrereqs from './react-components/sm-prerequisites.md'
import Install from './react-components/install-docker-compose.md'

<details>
<summary>Have you installed Camunda yet?</summary>
<SmPrereqs/>
<Install/>
</details>

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.

Expand Down
12 changes: 10 additions & 2 deletions docs/guides/getting-started-orchestrate-human-tasks.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
id: orchestrate-human-tasks
title: Get started with human task orchestration
sidebar_label: Getting started with human task orchestration
sidebar_label: Get started with human task orchestration
description: "Efficiently allocate work through user tasks."
keywords: [human tasks, orchestration, getting started, user guide]
---

<span class="badge badge--beginner">Beginner</span>
<span class="badge badge--medium">Time estimate: 15 minutes</span>
<span class="badge badge--medium">Time estimate: 15 minutes</span><br /><br />

import ExpressionInputImg from './img/expression-input-example.png';
import FormValuesImg from './img/form-values-example.png';
Expand All @@ -22,6 +22,14 @@ import FormEditorImg from './img/form-editor.png';
import NavigationHistoryImg from './img/modeler-navigation-history.png';

import clsx from "clsx";
import SmPrereqs from './react-components/sm-prerequisites.md'
import Install from './react-components/install-docker-compose.md'

<details>
<summary>Have you installed Camunda yet?</summary>
<SmPrereqs/>
<Install/>
</details>

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.

Expand Down
30 changes: 27 additions & 3 deletions docs/guides/getting-started-orchestrate-microservices.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,48 @@
---
id: orchestrate-microservices
title: Get started with microservice orchestration
sidebar_label: Getting started with microservice orchestration
sidebar_label: Get started with microservice orchestration
description: "Orchestrate Microservices along a business process for visibility and resilience."
keywords: [microservices, orchestration, getting-started]
---

<span class="badge badge--beginner">Beginner</span>
<span class="badge badge--medium">Time estimate: 25 minutes</span>
<span class="badge badge--medium">Time estimate: 25 minutes</span><br /><br />

import clsx from "clsx";
import Tabs from '@theme/Tabs';
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'

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.

While this guide uses code snippets in Java, you do not need to be a Java developer to be successful. Additionally, you can orchestrate microservices with Camunda 8 in other programming languages.

## Prerequisites

- Ensure you have a valid [Camunda 8 account](create-account.md), or sign up if you still need one.
You must have access to either a local or remote Camunda Self-Managed installation or a SaaS account.

<Tabs>
<TabItem value="sm" label="Self-Managed" default>
<details>
<summary>Have you installed Camunda yet?</summary>
<SmPrereqs/>
<Install/>
</details>
</TabItem>
<TabItem value="saas" label="SaaS">
<details>
<summary>Have you signed up for Camunda yet?</summary>
<SaasPrereqs/>
</details>
</TabItem>
</Tabs>

Additionally, you need the following:

- Java >= 8
- Maven
- IDE (IntelliJ, VSCode, or similar)
Expand Down
9 changes: 8 additions & 1 deletion docs/guides/model-your-first-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,15 @@ title: Model your first process
description: "Use Modeler to design and deploy a process."
---

import SaasPrereqs from './react-components/saas-prerequisites.md'

<span class="badge badge--beginner">Beginner</span>
<span class="badge badge--medium">Time estimate: 15 minutes</span>
<span class="badge badge--medium">Time estimate: 15 minutes</span><br /><br />

<details>
<summary>Have you signed up for Camunda yet?</summary>
<SaasPrereqs/>
</details>

## Design and deploy a process

Expand Down
11 changes: 11 additions & 0 deletions docs/guides/react-components/install-docker-compose.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
---

## Step 1: Install Camunda 8 Self-Managed

If you haven't already, follow [this guide](/self-managed/setup/deploy/local/docker-compose.md) to install Camunda 8 Self-Managed locally via Docker Compose:

1. Use the `docker-compose.yaml` file in [this repository](https://github.com/camunda/camunda-platform).
2. Clone this repo and run `docker compose up -d` in your terminal to start your environment.

To confirm Camunda 8 Self-Managed is installed, click into Docker Desktop. Here, you will see the `camunda-platform` container. Alternatively, navigate to the different components and log in with the username `demo` and password `demo`. For example, Operate can be accessed at [http://localhost:8081](http://localhost:8081) (as noted under **Port(s)** in the Docker container). Find additional guidance in the repository [README](https://github.com/camunda/camunda-platform?tab=readme-ov-file#using-docker-compose).
20 changes: 20 additions & 0 deletions docs/guides/react-components/install-plain-java.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
---

## Step 1: Install Camunda 8 Self-Managed

**Starting in 8.6.0-alpha3**, 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-alpha3 or later

Download the [latest release artifact](https://github.com/camunda/camunda/releases), starting with 8.6.0-alpha3.

Follow README.md to start Camunda and Elasticsearch.

<!-- (Disclaimer: since the 8.6.0-alpha3 release, you can also start Camunda as an integrated plain old Java application.
Prereq: have JDK 21+ locally installed, use Camunda 8.6.0-alpha3 or later
Download latest release artifact from https://github.com/camunda/camunda/releases (min.: 8.6.0-alpha3)
Follow README.md in the archive to start camunda process, and elasticsearch -->
26 changes: 26 additions & 0 deletions docs/guides/react-components/saas-prerequisites.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
---

## Sign Up

Visit [camunda.io/signup](https://signup.camunda.com/accounts?utm_source=docs.camunda.io&utm_medium=referral) and view the **Sign Up** screen:

![signup](./../img/signup.png)

### Create an account

Fill out the form and submit, or sign up using the social sign up buttons like Google or GitHub.

When you fill out the form, you'll receive a confirmation email. Click on the link to verify your email address.

If you choose to create an account through the social sign up buttons, you'll be redirected to [Console](/components/console/introduction-to-console.md) directly.

## Log in to your Camunda 8 account

Log in with the email address and password you used in the previous form, or use the social login buttons. To access the login site directly, navigate to [camunda.io](https://weblogin.cloud.camunda.io/).

![login](./../img/login.png)

After login, select the square-shaped **Camunda components** icon in the upper-left corner, and select Console to view the Console overview page. This is the central place to manage the clusters, diagrams, and forms you want to deploy to Camunda 8.

![overview-home](./../img/home.png)
11 changes: 11 additions & 0 deletions docs/guides/react-components/sm-prerequisites.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
---

## Prerequisites

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/).
6 changes: 1 addition & 5 deletions docs/guides/help-center.md → docs/reference/help-center.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,9 @@ id: camunda-help-center
title: Access the Camunda Help Center
sidebar_label: Access the Camunda Help Center
description: "Get recommendations for additional learning, step through the automation project guide, have a closer look at various use cases, access Camunda Academy, share feedback, and more."
keywords: [getting-started, help-center, help, support]
keywords: [help-center, help, support]
---

<span class="badge badge--beginner">Beginner</span>
<span class="badge badge--cloud">Camunda 8 SaaS only</span>
<span class="badge badge--medium">Time estimate: 10 minutes</span>

Camunda 8 SaaS offers a Help Center to all users, where you can access additional documentation, step through various use cases in Camunda, share your feedback, and more.

## Visiting the Help Center
Expand Down
File renamed without changes
4 changes: 4 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,10 @@ module.exports = {
label: "How to use our docs",
to: "meta",
},
{
label: "Camunda Help Center",
to: "docs/reference/help-center",
},
{
label: "Try free",
href: "https://signup.camunda.com/accounts?utm_source=docs.camunda.io&utm_medium=referral&utm_content=footer",
Expand Down
21 changes: 12 additions & 9 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,18 @@ function optimizeLink(label, href) {

module.exports = {
Guides: [
"guides/introduction-to-camunda",
{
"Get started": [
"guides/introduction-to-camunda",
"guides/create-account",
"guides/camunda-help-center",
"guides/model-your-first-process",
"guides/orchestrate-human-tasks",
"guides/orchestrate-apis",
"guides/orchestrate-microservices",
"guides/getting-started-java-spring",
"guides/model-your-first-process",
{
"Use cases": [
"guides/orchestrate-human-tasks",
"guides/orchestrate-apis",
"guides/orchestrate-microservices",
],
},
],
},
{
Expand Down Expand Up @@ -849,10 +851,11 @@ module.exports = {
},
items: ["reference/release-notes/860", "reference/release-notes/850"],
},
"reference/auto-updates",
"reference/status",
"reference/supported-environments",
"reference/dependencies",
"reference/camunda-help-center",
"reference/auto-updates",
"reference/status",
"reference/alpha-features",
"reference/licenses",
"reference/notices",
Expand Down

0 comments on commit 6fccb2a

Please sign in to comment.