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

Consolidate intro to camunda #4181

Merged
merged 12 commits into from
Aug 30, 2024
15 changes: 1 addition & 14 deletions docs/components/components-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,7 @@ keywords: ["process automation tools"]

This section contains product manual content for each component in Camunda 8, including conceptual content. Together, these components comprise the Camunda 8 SaaS experience.

- [Concepts](concepts/what-is-camunda-8.md) - Learn more about a variety of Camunda 8 topics with this conceptual documentation on clusters, processes, job workers, workflow patterns, and more.
- [Console](console/introduction-to-console.md) - With this management application for the included products, create and delete clusters, manage API clients and alerts, and more.
- [Modeler](modeler/about-modeler.md) - Design and implement diagrams using Camunda's modeling tools, including Web Modeler and Desktop Modeler.
- [Connectors](connectors/introduction.md) - Integrate with external systems using these reusable building blocks.
- [Zeebe](zeebe/zeebe-overview.md) - Define processes graphically in BPMN 2.0, choose any gRPC-supported programming language to implement your workers, build processes that react to events from Apache Kafka, and more using this process automation engine powering Camunda 8.
- [Operate](operate/operate-introduction.md) - Monitor and troubleshoot process instances running in Zeebe, and carry out key operations such as resolving incidents and updating process instance variables with Operate.
- [Tasklist](tasklist/introduction-to-tasklist.md) - Implement business processes alongside user tasks in Zeebe, and orchestrate human workflows critical to your business to reduce time-to-value for your process orchestration projects with this interface for manual work.
- [Optimize]($optimize$/components/what-is-optimize) - Geared toward business stakeholders, Optimize offers business intelligence tooling for Camunda enterprise customers. By leveraging data collected during process execution, users can collaboratively examine areas in business processes for improvement.

:::note
Additionally, Camunda hosts a section of [Best Practices](./best-practices/best-practices-overview.md). A mix of conceptual and practical implementation information, this section hosts our condensed experience using BPMN and DMN on the Camunda tool stack collected by consulting engagement with our customers and feedback from the community.
:::

![Architecture diagram for Camunda including all the components for SaaS](./img/ComponentsAndArchitecture_SaaS.png)
See our [introduction to Camunda](/guides/introduction-to-camunda-8.md) if you are new to Camunda, or visiting the Camunda documentation for the first time.

:::note Looking for deployment guides?

Expand Down
2 changes: 1 addition & 1 deletion docs/components/modeler/about-modeler.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: about-modeler
title: About Modeler
description: "Any executable process needs a BPMN diagram designed and configured beforehand. Camunda offers Web Modeler and Desktop Modeler to design and implement these."
description: "Camunda offers Web Modeler and Desktop Modeler to design and implement any executable process using BPMN."
keywords: ["process mapping tool"]
---

Expand Down
2 changes: 1 addition & 1 deletion docs/components/operate/operate-introduction.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: operate-introduction
title: Introduction
description: "Operate is a tool for monitoring and troubleshooting process instances running in Zeebe."
description: "Operate is a tool managing, monitoring, and troubleshooting your processes."
---

Operate is a tool for monitoring and troubleshooting process instances running in [Zeebe](/components/zeebe/zeebe-overview.md).
Expand Down
2 changes: 1 addition & 1 deletion docs/components/tasklist/introduction-to-tasklist.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: introduction-to-tasklist
title: Introduction
description: "Tasklist is a ready-to-use application to work on user tasks."
description: "Orchestrate human workflows critical to your business with an out-of-the-box interface for manual work, known as user tasks."
---

Tasklist is a ready-to-use application to rapidly implement business processes alongside [user tasks](/components/modeler/bpmn/user-tasks/user-tasks.md).
Expand Down
2 changes: 1 addition & 1 deletion docs/components/zeebe/zeebe-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: zeebe-overview
title: "Zeebe"
sidebar_label: "Introduction"
description: "Zeebe is the process automation engine powering Camunda 8."
description: "Zeebe is the process automation engine powering Camunda 8. While written in Java, you do not need to be a Java developer to use Zeebe."
---

Zeebe is the process automation engine powering Camunda 8. While written in Java, you do not need to be a Java developer to use Zeebe.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/automating-a-process-using-bpmn.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: automating-a-process-using-bpmn
title: Design a process using BPMN
description: A quickstart on how to use BPMN, an easy-to-adopt visual modeling language, together with Camunda to automate your business processes.
description: A quickstart on how to use BPMN, a visual modeling language, together with Camunda to automate your business processes.
keywords: [workflow, modeling]
---

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/configuring-out-of-the-box-connector.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: configuring-out-of-the-box-connectors
title: Configure an out-of-the-box Connector
description: "Connectors communicate with any system or technology, reducing the time it takes to automate and orchestrate business processes across systems."
description: "Ready to use out of the box, Connectors help automate complex business processes by inserting them into BPMN diagrams."
keywords: [connector, modeling, connectors, low-code, no-code]
---

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/create-cluster.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: create-cluster
title: Create your cluster
description: "To deploy and run your process, you must create a cluster in Camunda 8. While the cluster is being created, you can still proceed to begin modeling."
description: "Create a cluster in Camunda 8 to deploy and run your process."
---

import CreateCluster from '../components/react-components/create-cluster.md'
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/getting-started-orchestrate-microservices.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: orchestrate-microservices
title: Get started with microservice orchestration
sidebar_label: Get started with microservice orchestration
description: "Orchestrate Microservices along a business process for visibility and resilience."
description: "Orchestrate microservices for visibility and resilience."
keywords: [microservices, orchestration, getting-started]
---

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/improve-processes-with-optimize.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: improve-processes-with-optimize
title: Improve processes with Optimize
sidebar_label: Improve processes with Optimize
description: "The following document provides a basic end-to-end glance into Optimize and its features for new business users."
description: "Leverage data collected during process execution, analyze bottlenecks, and examine areas for improvement."
---

<span class="badge badge--beginner">Beginner</span>
Expand Down
66 changes: 37 additions & 29 deletions docs/guides/introduction-to-camunda-8.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,47 +3,55 @@ id: introduction-to-camunda
title: Introduction to Camunda 8
sidebar_label: Introduction to Camunda 8
slug: /guides/
description: "Step through an introduction to Camunda 8, creating an account, modeling your first process, getting started with microservice orchestration, and more."
description: "Learn about Camunda 8, a platform that delivers scalable, on-demand process automation as-a-service, paired with tools for collaborative modeling and operations."
---

import DocCardList from '@theme/DocCardList';

:::note Interested in migrating from Camunda 7 to Camunda 8?
Interested in migrating process solutions developed for Camunda 7 to run them on Camunda 8? Visit our guide on [migrating from Camunda 7](/guides/migrating-from-camunda-7/index.md).
:::

[Camunda 8](https://camunda.io) delivers scalable, on-demand process automation as-a-service. Camunda 8 is combined with powerful execution engines for BPMN processes and DMN decisions, and paired with tools for collaborative modeling, operations, and analytics.

Camunda 8 consists of six [components](/components/components-overview.md):
Camunda 8 consists of six [components](/components/components-overview.md). Together, these components form the complete Camunda 8 experience to design, automate, and improve your business processes.

- [Console](/components/console/introduction-to-console.md) - Configure and deploy clusters with Console.
- [Web Modeler](/components/modeler/about-modeler.md) - Collaborate, model processes, and deploy or start new instances. Note that Camunda 8 can be used with both [Desktop Modeler](/components/modeler/desktop-modeler/index.md) and [Web Modeler](/components/modeler/web-modeler/launch-web-modeler.md).
- [Zeebe](/components/zeebe/zeebe-overview.md) - The cloud-native process engine of Camunda 8.
- [Tasklist](/components/tasklist/introduction-to-tasklist.md) - Complete tasks which require human input.
- [Operate](/components/operate/operate-introduction.md) - Manage, monitor, and troubleshoot your processes.
- [Optimize]($optimize$/components/what-is-optimize) - Improve your processes by identifying constraints in your system.
In the architecture diagram below, take a closer look at how these components work together. Don't worry if you're not sure about all the terminology yet, as this is merely a visual overview of how the components form a unified experience. Step through the [getting started section](#getting-started) below to get started with Camunda for the first time, or find additional details in [What is Camunda 8](components/concepts/what-is-camunda-8.md), and an on-demand demonstration of the product in [Camunda Academy](https://bit.ly/3CvooTX).

For more conceptual information about Camunda 8, see [What is Camunda 8](components/concepts/what-is-camunda-8.md).
For an on-demand demonstration of the product, visit [Camunda Academy](https://bit.ly/3CvooTX).
![Architecture diagram for Camunda including all the components for SaaS](./img/ComponentsAndArchitecture_SaaS.png)

:::note Looking for deployment guides?

Deployment guides for Camunda 8 components are available in the [Self-Managed section](/self-managed/about-self-managed.md), a self-hosted alternative to using Camunda 8 SaaS.

:::note
Interested in migrating process solutions developed for Camunda 7 to run them on Camunda 8? Visit our guide on [migrating from Camunda 7](/guides/migrating-from-camunda-7/index.md).
:::

## Getting started

In this section of the Camunda 8 documentation, you'll find guides to get started with Camunda 8 before learning more about each individual [component](/components/components-overview.md). Our getting started guides walk you through the following steps:
Below are two excellent starting points if you're new to Camunda: modeling a process, and getting started with Spring:

<DocCardList items={[{type:"link", href:"/docs/next/components/modeler/about-modeler/", label: "Model your first process", docId:"components/modeler/about-modeler"},
{
type:"link", href:"/docs/next/guides/getting-started-java-spring/", label: "Get started with Spring", docId:"guides/getting-started-java-spring",
}
]}/>

With these guides, start working with [Web Modeler](/components/modeler/about-modeler.md) to get familiar with BMPN and model a business process, or as a Java developer, step through using Spring Boot and the Spring Zeebe SDK with Desktop Modeler to interact with a local Self-Managed Camunda 8 installation.

### Use cases

As you're getting started with Camunda, you can also learn more about some of our use cases:

- [**Get started with human task orchestration**](/guides/getting-started-orchestrate-human-tasks.md): 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.
- [**Get started with API orchestration**](/guides/getting-started-orchestrate-apis.md): Step through making a request to a REST API and using the response in the next steps of your process.
- [**Get started with microservice orchestration**](/guides/getting-started-orchestrate-microservices.md): Orchestrate the microservices necessary to achieve your end-to-end automated business process.

1. [Create a Camunda 8 account](./create-account.md) - Create a Camunda 8 account to create clusters, deploy processes, and create a new instance.
2. [Model your first process](./model-your-first-process.md) - Design and deploy a process, and share the process with your teammates or other stakeholders to begin collaborating.
3. [Create a cluster](./create-cluster.md) - Create your first cluster to execute processes.
4. [Orchestrate human tasks](./getting-started-orchestrate-human-tasks.md) - Assign human tasks to users so they can enter the necessary data to drive the business process forward.
5. [Get started with API orchestration](./getting-started-orchestrate-apis.md) - Configure Connector tasks with domain-specific parameters.
6. [Orchestrate microservices](./getting-started-orchestrate-microservices.md) - Orchestrate the microservices necessary to achieve your end-to-end automated business process.
## Design, automate, and improve

## Learn more
After getting started with Camunda, get to know the platform through the following sections:

After getting started with Camunda 8, dive deeper in our next steps section of the guides by learning about the following:
- **Design**: Have a closer look at [designing with BPMN](/guides/automating-a-process-using-bpmn.md), or [creating decision tables using DMN](/guides/create-decision-tables-using-dmn.md).
- **Automate**: [Get to know Connectors](/guides/configuring-out-of-the-box-connector.md), reusable building blocks that integrate with external systems. Or, [set up client connection credentials](/guides/setup-client-connection-credentials.md) to create, name, and connect your client.
- **Improve**: [Get Optimize involved in your processes](/guides/improve-processes-with-optimize.md). By leveraging data collected during process execution, you can access reports, share process intelligence, analyze bottlenecks, and examine areas in business processes for improvement. Alternatively, [apply continuous integration and continuous deployment (CI/CD) pipelines](/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md) for automated production deployments.

- [Set up your first development project](./setting-up-development-project.md) - Set up your first project to model, deploy, and start a process instance.
- [Set up client connection credentials](./setup-client-connection-credentials.md) - Create, name, and connect your client.
- [Automate a process using BPMN](./automating-a-process-using-bpmn.md) - Learn more about the mechanics and elements of BPMN, and build your first BPMN diagram.
- [Configuring an out-of-the-box Connector](./configuring-out-of-the-box-connector.md) - Automate complex business processes by inserting them into BPMN diagrams within Web Modeler.
- [Create decision tables with DMN](./create-decision-tables-using-dmn.md) - Learn more about Decision Model and Notation to model a set of rules within a table, and yield a decision to rapidly execute a process using a decision engine like Camunda.
- [Build forms with Modeler](./utilizing-forms.md) - Design and configure forms and connect them to a user task or start event to implement a task form in your application.
- [Improve processes with Optimize](./improve-processes-with-optimize.md) - Leverage data collected during process execution to access reports, share process intelligence, analyze bottlenecks, and examine areas in business processes for improvement.
- [Message correlation](./message-correlation.md) - Target a running workflow with a state update from an external system asynchronously.
Additionally, Camunda hosts a section of [Best Practices](/components/best-practices/best-practices-overview.md). A mix of conceptual and practical implementation information, this section hosts our condensed experience using BPMN and DMN on the Camunda tool stack collected by consulting engagement with our customers and feedback from the community.
Loading