Skip to content

Commit

Permalink
Doc maintenance March 2025 (#5129)
Browse files Browse the repository at this point in the history
* Add img alt tags

* Fix meta descriptions
  • Loading branch information
mesellings authored Mar 3, 2025
1 parent 2e63f76 commit 751dada
Show file tree
Hide file tree
Showing 20 changed files with 23 additions and 26 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ In Camunda, you do _not_ declare process variables in the process model. This al

Consult the [docs about variables](/components/concepts/variables.md#variable-values) to learn more.

Camunda does not treat BPMN **data objects** (<img src="/img/bpmn-elements/data-object.svg" width="60" />) as process variables. We recommend using them occasionally _for documentation_, but you need to [avoid excessive usage of data objects](../../modeling/creating-readable-process-models#avoiding-excessive-usage-of-data-objects).
Camunda does not treat BPMN **data objects** (<img src="/img/bpmn-elements/data-object.svg" width="60" alt="BPMN data object" />) as process variables. We recommend using them occasionally _for documentation_, but you need to [avoid excessive usage of data objects](../../modeling/creating-readable-process-models#avoiding-excessive-usage-of-data-objects).

## Storing just the relevant data

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -737,7 +737,7 @@ To call a **SAP** system, you have the following options:

A script task...

<img src="/img/bpmn-elements/task-script.svg" />
<img src="/img/bpmn-elements/task-script.svg" alt="task script" />

&nbsp;...is defined by specifying the script and the `scriptFormat`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Aside a general strategy to mark service tasks as being save points you will oft

**Do** configure a savepoint **after**

- _User tasks_ <img src="/img/bpmn-elements/task-user.svg"/>: This savepoint allows users to complete their tasks without waiting for expensive subsequent steps and without seeing an unexpected rollback of their user transaction to the waitstate before the user task. Sometimes, e.g. when validating user input by means of a subsequent step, you want exactly that: rolling back the user transaction to the user task waitstate. In that case you might want to introduce a savepoint right after the validation step.
- _User tasks_ <img src="/img/bpmn-elements/task-user.svg" alt="User Task" />: This savepoint allows users to complete their tasks without waiting for expensive subsequent steps and without seeing an unexpected rollback of their user transaction to the waitstate before the user task. Sometimes, e.g. when validating user input by means of a subsequent step, you want exactly that: rolling back the user transaction to the user task waitstate. In that case you might want to introduce a savepoint right after the validation step.

- Service Tasks (or other steps) causing _Non-idempotent Side Effects_ <img src="/img/bpmn-elements/task-service.svg" alt="Service Task" /> <img src="/img/bpmn-elements/task-script.svg" alt="Script Task" /> <img src="/img/bpmn-elements/task-send.svg" alt="Send Task" /> <img src="/img/bpmn-elements/message-intermediate-send.svg" alt="Message Intermediate Event" /> <img src="/img/bpmn-elements/message-end.svg" alt="Message End Event" />: This savepoint makes sure that a side effect which must not happen more often than once is not accidentally repeated because any subsequent steps might roll back the transaction to a savepoint well before the affected step. End Events should be included if the process can be called from other processes.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,13 +107,13 @@ Make your models easier to understand by modeling _explicitly_, which most often

#### Using gateways instead of conditional flows

Model splitting the process flow by always using _gateway symbols_ such as <img src="/img/bpmn-elements/inclusive-gateway.svg" className="inline-image" /> instead of conditional flows <img src="/img/bpmn-elements/conditional-flow.svg" className="inline-image" />.
Model splitting the process flow by always using _gateway symbols_ such as <img src="/img/bpmn-elements/inclusive-gateway.svg" className="inline-image" alt="Inclusive gateway" /> instead of conditional flows <img src="/img/bpmn-elements/conditional-flow.svg" className="inline-image" alt="Conditional flow" />.

<div bpmn="best-practices/creating-readable-process-models-assets/explicit-gateways-instead-of-conditional-flows.bpmn" callouts="inclusive_gateway" />

<span className="callout">1</span>

For example, you could've left out this inclusive gateway by drawing two outgoing sequence flows directly out of the preceding task **Choose menu** and attaching conditions to those sequence flows (becoming conditional sequence flows <img src="/img/bpmn-elements/conditional-flow.svg" className="inline-image" />). However, experience shows that readers understand the flow semantics of gateways better, which is why we do not make use of this possibility.
For example, you could've left out this inclusive gateway by drawing two outgoing sequence flows directly out of the preceding task **Choose menu** and attaching conditions to those sequence flows (becoming conditional sequence flows <img src="/img/bpmn-elements/conditional-flow.svg" className="inline-image" alt="Conditional flow" />). However, experience shows that readers understand the flow semantics of gateways better, which is why we do not make use of this possibility.

#### Modeling start and end events

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ and how it can be configured by process developers. Connector templates are a sp

A connector consists of the actual Java code, and the Modeler user interface.

<img src={ConnectorArchitectureImg}/>
<img src={ConnectorArchitectureImg} alt="Diagram showing the architecture of a connector" />

1. The Java code defines the connector functionality and how it connects to an external system. For example, the [Connector function](/components/connectors/custom-built-connectors/connector-sdk.md#outbound-connector-runtime-logic) for outbound connectors.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/modeler/dmn/dmn.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: desktop-modeler-dmn
title: DMN in Modeler
description: "Camunda Desktop and Web Modeler both offer the same Modeling experience for DMN 1.3 models: Modeling starts in the Decision Requirements Diagram (DRD) view."
description: "Camunda Desktop and Web Modeler both offer the same Modeling experience for DMN 1.3 models, with modeling starting in the Decision Requirements Diagram (DRD) view."
---

## Start modeling
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
id: feel-built-in-functions-introduction
title: Introduction
description: "FEEL includes many built-in functions. These functions can be invoked
in expressions and unary-tests."
description: "FEEL includes many built-in functions. These functions can be invoked in expressions and unary-tests."
---

FEEL includes many built-in functions. These functions can be invoked
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ In Camunda, you do _not_ declare process variables in the process model. This al

Consult the [docs about variables](/components/concepts/variables.md#variable-values) to learn more.

Camunda does not treat BPMN **data objects** (<img src="/img/bpmn-elements/data-object.svg" width="60" />) as process variables. We recommend using them occasionally _for documentation_, but you need to [avoid excessive usage of data objects](../../modeling/creating-readable-process-models#avoiding-excessive-usage-of-data-objects).
Camunda does not treat BPMN **data objects** (<img src="/img/bpmn-elements/data-object.svg" width="60" alt="BPMN data object" />) as process variables. We recommend using them occasionally _for documentation_, but you need to [avoid excessive usage of data objects](../../modeling/creating-readable-process-models#avoiding-excessive-usage-of-data-objects).

## Storing just the relevant data

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -736,7 +736,7 @@ To call a **SAP** system, you have the following options:

A script task...

<img src="/img/bpmn-elements/task-script.svg" />
<img src="/img/bpmn-elements/task-script.svg" alt="task script" />

&nbsp;...is defined by specifying the script and the `scriptFormat`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Aside a general strategy to mark service tasks as being save points you will oft

**Do** configure a savepoint **after**

- _User tasks_ <img src="/img/bpmn-elements/task-user.svg"/>: This savepoint allows users to complete their tasks without waiting for expensive subsequent steps and without seeing an unexpected rollback of their user transaction to the waitstate before the user task. Sometimes, e.g. when validating user input by means of a subsequent step, you want exactly that: rolling back the user transaction to the user task waitstate. In that case you might want to introduce a savepoint right after the validation step.
- _User tasks_ <img src="/img/bpmn-elements/task-user.svg" alt="User Task" />: This savepoint allows users to complete their tasks without waiting for expensive subsequent steps and without seeing an unexpected rollback of their user transaction to the waitstate before the user task. Sometimes, e.g. when validating user input by means of a subsequent step, you want exactly that: rolling back the user transaction to the user task waitstate. In that case you might want to introduce a savepoint right after the validation step.

- Service Tasks (or other steps) causing _Non-idempotent Side Effects_ <img src="/img/bpmn-elements/task-service.svg" alt="Service Task" /> <img src="/img/bpmn-elements/task-script.svg" alt="Script Task" /> <img src="/img/bpmn-elements/task-send.svg" alt="Send Task" /> <img src="/img/bpmn-elements/message-intermediate-send.svg" alt="Message Intermediate Event" /> <img src="/img/bpmn-elements/message-end.svg" alt="Message End Event" />: This savepoint makes sure that a side effect which must not happen more often than once is not accidentally repeated because any subsequent steps might roll back the transaction to a savepoint well before the affected step. End Events should be included if the process can be called from other processes.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,13 +107,13 @@ Make your models easier to understand by modeling _explicitly_, which most often

#### Using gateways instead of conditional flows

Model splitting the process flow by always using _gateway symbols_ like <img src="/img/bpmn-elements/inclusive-gateway.svg" className="inline-image" /> instead of conditional flows <img src="/img/bpmn-elements/conditional-flow.svg" className="inline-image" />.
Model splitting the process flow by always using _gateway symbols_ like <img src="/img/bpmn-elements/inclusive-gateway.svg" className="inline-image" alt="Inclusive gateway" /> instead of conditional flows <img src="/img/bpmn-elements/conditional-flow.svg" className="inline-image" alt="Conditional flow" />.

<div bpmn="best-practices/creating-readable-process-models-assets/explicit-gateways-instead-of-conditional-flows.bpmn" callouts="inclusive_gateway" />

<span className="callout">1</span>

For example, you could've left out this inclusive gateway by drawing two outgoing sequence flows directly out of the preceding task **Choose menu** and attaching conditions to those sequence flows (becoming conditional sequence flows <img src="/img/bpmn-elements/conditional-flow.svg" className="inline-image" />). However, experience shows that readers understand the flow semantics of gateways better, which is why we do not make use of this possibility.
For example, you could've left out this inclusive gateway by drawing two outgoing sequence flows directly out of the preceding task **Choose menu** and attaching conditions to those sequence flows (becoming conditional sequence flows <img src="/img/bpmn-elements/conditional-flow.svg" className="inline-image" alt="Conditional flow" />). However, experience shows that readers understand the flow semantics of gateways better, which is why we do not make use of this possibility.

#### Modeling start and end events

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-8.6/components/modeler/dmn/dmn.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: desktop-modeler-dmn
title: DMN in Modeler
description: "Camunda Desktop and Web Modeler both offer the same Modeling experience for DMN 1.3 models: Modeling starts in the Decision Requirements Diagram (DRD) view."
description: "Camunda Desktop and Web Modeler both offer the same Modeling experience for DMN 1.3 models, with modeling starting in the Decision Requirements Diagram (DRD) view."
---

## Start modeling
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
id: feel-built-in-functions-introduction
title: Introduction
description: "FEEL includes many built-in functions. These functions can be invoked
in expressions and unary-tests."
description: "FEEL includes many built-in functions. These functions can be invoked in expressions and unary-tests."
---

FEEL includes many built-in functions. These functions can be invoked
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ In Camunda, you do _not_ declare process variables in the process model. This al

Consult the [docs about variables](/components/concepts/variables.md#variable-values) to learn more.

Camunda does not treat BPMN **data objects** (<img src="/img/bpmn-elements/data-object.svg" width="60" />) as process variables. We recommend using them occasionally _for documentation_, but you need to [avoid excessive usage of data objects](../../modeling/creating-readable-process-models#avoiding-excessive-usage-of-data-objects).
Camunda does not treat BPMN **data objects** (<img src="/img/bpmn-elements/data-object.svg" width="60" alt="BPMN data object" />) as process variables. We recommend using them occasionally _for documentation_, but you need to [avoid excessive usage of data objects](../../modeling/creating-readable-process-models#avoiding-excessive-usage-of-data-objects).

## Storing just the relevant data

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -737,7 +737,7 @@ To call a **SAP** system, you have the following options:

A script task...

<img src="/img/bpmn-elements/task-script.svg" />
<img src="/img/bpmn-elements/task-script.svg" alt="task script" />

&nbsp;...is defined by specifying the script and the `scriptFormat`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Aside a general strategy to mark service tasks as being save points you will oft

**Do** configure a savepoint **after**

- _User tasks_ <img src="/img/bpmn-elements/task-user.svg"/>: This savepoint allows users to complete their tasks without waiting for expensive subsequent steps and without seeing an unexpected rollback of their user transaction to the waitstate before the user task. Sometimes, e.g. when validating user input by means of a subsequent step, you want exactly that: rolling back the user transaction to the user task waitstate. In that case you might want to introduce a savepoint right after the validation step.
- _User tasks_ <img src="/img/bpmn-elements/task-user.svg" alt="User Task"/>: This savepoint allows users to complete their tasks without waiting for expensive subsequent steps and without seeing an unexpected rollback of their user transaction to the waitstate before the user task. Sometimes, e.g. when validating user input by means of a subsequent step, you want exactly that: rolling back the user transaction to the user task waitstate. In that case you might want to introduce a savepoint right after the validation step.

- Service Tasks (or other steps) causing _Non-idempotent Side Effects_ <img src="/img/bpmn-elements/task-service.svg" alt="Service Task" /> <img src="/img/bpmn-elements/task-script.svg" alt="Script Task" /> <img src="/img/bpmn-elements/task-send.svg" alt="Send Task" /> <img src="/img/bpmn-elements/message-intermediate-send.svg" alt="Message Intermediate Event" /> <img src="/img/bpmn-elements/message-end.svg" alt="Message End Event" />: This savepoint makes sure that a side effect which must not happen more often than once is not accidentally repeated because any subsequent steps might roll back the transaction to a savepoint well before the affected step. End Events should be included if the process can be called from other processes.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,13 +107,13 @@ Make your models easier to understand by modeling _explicitly_, which most often

#### Using gateways instead of conditional flows

Model splitting the process flow by always using _gateway symbols_ such as <img src="/img/bpmn-elements/inclusive-gateway.svg" className="inline-image" /> instead of conditional flows <img src="/img/bpmn-elements/conditional-flow.svg" className="inline-image" />.
Model splitting the process flow by always using _gateway symbols_ such as <img src="/img/bpmn-elements/inclusive-gateway.svg" className="inline-image" alt="Inclusive gateway" /> instead of conditional flows <img src="/img/bpmn-elements/conditional-flow.svg" className="inline-image" alt="Conditional flow" />.

<div bpmn="best-practices/creating-readable-process-models-assets/explicit-gateways-instead-of-conditional-flows.bpmn" callouts="inclusive_gateway" />

<span className="callout">1</span>

For example, you could've left out this inclusive gateway by drawing two outgoing sequence flows directly out of the preceding task **Choose menu** and attaching conditions to those sequence flows (becoming conditional sequence flows <img src="/img/bpmn-elements/conditional-flow.svg" className="inline-image" />). However, experience shows that readers understand the flow semantics of gateways better, which is why we do not make use of this possibility.
For example, you could've left out this inclusive gateway by drawing two outgoing sequence flows directly out of the preceding task **Choose menu** and attaching conditions to those sequence flows (becoming conditional sequence flows <img src="/img/bpmn-elements/conditional-flow.svg" className="inline-image" alt="Conditional flow"/>). However, experience shows that readers understand the flow semantics of gateways better, which is why we do not make use of this possibility.

#### Modeling start and end events

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ and how it can be configured by process developers. Connector templates are a sp

A connector consists of the actual Java code, and the Modeler user interface.

<img src={ConnectorArchitectureImg}/>
<img src={ConnectorArchitectureImg} alt="Diagram showing the architecture of a connector" />

1. The Java code defines the connector functionality and how it connects to an external system. For example, the [Connector function](/components/connectors/custom-built-connectors/connector-sdk.md#outbound-connector-runtime-logic) for outbound connectors.

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-8.7/components/modeler/dmn/dmn.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: desktop-modeler-dmn
title: DMN in Modeler
description: "Camunda Desktop and Web Modeler both offer the same Modeling experience for DMN 1.3 models: Modeling starts in the Decision Requirements Diagram (DRD) view."
description: "Camunda Desktop and Web Modeler both offer the same Modeling experience for DMN 1.3 models, with modeling starting in the Decision Requirements Diagram (DRD) view."
---

## Start modeling
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
id: feel-built-in-functions-introduction
title: Introduction
description: "FEEL includes many built-in functions. These functions can be invoked
in expressions and unary-tests."
description: "FEEL includes many built-in functions. These functions can be invoked in expressions and unary-tests."
---

FEEL includes many built-in functions. These functions can be invoked
Expand Down

0 comments on commit 751dada

Please sign in to comment.