docs(concepts): Add documentation for Execution Listeners #4017

ce-dmelnych · 2024-07-04T08:02:04Z

Description

This PR adds documentation for Execution Listeners (EL) in Camunda 8, providing developers with a guide on how to implement and utilize ELs effectively in their workflows.

It includes the following sections:

Introduction: Overview, and use cases of ELs.
Getting Started: Steps to enable ELs in BPMN models.
Limitations: ELs limitations.
Usage: How to define Job Workers to process EL jobs.
Variables: Handling variables within ELs, including scope and dynamic variable handling.
References: Links to additional documentation.

When should this change go live?

This is a bug fix, security concern, or something that needs urgent release support.
This is already available but undocumented and should be released within a week.
This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
This is part of a scheduled alpha or minor. (apply alpha or minor label)
There is no urgency with this change and can be released at any time.

PR Checklist

My changes are for an already released minor and are in /versioned_docs directory.
My changes are for the next minor and are in /docs directory (aka /next/).

My changes require an Engineering review, and I've assigned the Engineering DRI or delegate.
My changes require a technical writer review, and I've assigned @camunda/tech-writers as a reviewer.

This commit introduces initial documentation for ELs in Camunda 8. It includes the following sections: - **Introduction**: Overview, benefits, and use cases of ELs. - **Getting Started**: Steps to enable ELs in BPMN models. - **Supported Elements**: A table of BPMN elements that support `start` and `end` ELs. - **Parameters and Configuration**: Explanation of EL parameters and example configurations. - **Limitations**: ELs limitations. - **Usage**: How to define Job Workers to process EL jobs. - **Variables**: Handling variables within ELs, including scope and dynamic variable handling. - **Examples**: Some examples of EL usage. - **Element Processing Flow**: A flowchart and detailed steps describing the lifecycle of elements with ELs. - **FAQ**: Common questions and troubleshooting tips. - **References**: Links to additional documentation. The documentation aims to provide a guide for developers to effectively implement and utilize Execution Listeners in their workflows.

github-actions · 2024-07-04T08:02:29Z

👋 🤖 🤔 Hello! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.5/.

docs/components/concepts/execution-listeners.md
docs/reference/glossary.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

This commit introduces initial documentation for ELs in Camunda 8. It includes the following sections: - **Introduction**: Overview, benefits, and use cases of ELs. - **Getting Started**: Steps to enable ELs in BPMN models. - **Supported Elements**: A table of BPMN elements that support `start` and `end` ELs. - **Parameters and Configuration**: Explanation of EL parameters and example configurations. - **Limitations**: ELs limitations. - **Usage**: How to define Job Workers to process EL jobs. - **Variables**: Handling variables within ELs, including scope and dynamic variable handling. - **Examples**: Some examples of EL usage. - **Element Processing Flow**: A flowchart and detailed steps describing the lifecycle of elements with ELs. - **FAQ**: Common questions and troubleshooting tips. - **References**: Links to additional documentation. The documentation aims to provide a guide for developers to effectively implement and utilize Execution Listeners in their workflows.

…doc' into feature/add-execution-listeners-doc # Conflicts: # docs/components/concepts/execution-listeners.md

christinaausley · 2024-07-08T17:08:26Z

@ce-dmelnych Is this ready for review or not quite yet?

- adjust text for sections - improve formatting - add sections with limitations and workarounds

ce-dmelnych · 2024-07-09T13:24:01Z

@ce-dmelnych Is this ready for review or not quite yet?

Hi @christinaausley ,

I have made some corrections, and the PR is now ready for review. However, it also requires an engineering review, so there might be some additional changes after that.

@saig0, could you please assist with the engineering review?

Here is the preview of 🆕 Execution Listeners page.
Thanks!

github-actions · 2024-07-09T13:47:43Z

The preview environment relating to the commit 8e7fc39 has successfully been deployed. You can access it on https://preview.docs.camunda.cloud/pr-4017/index.html.

christinaausley · 2024-07-17T18:15:50Z

@ce-dmelnych Cool 👍 I'll have a look after @saig0.

saig0

@ce-dmelnych thank you for writing the docs. It's a good start. 👍

However, I see the potential to make it more effective for users by rephrasing and restructuring some parts. I will schedule a meeting with you to discuss the improvements.

docs/components/concepts/execution-listeners.md

- restructure content - remove not relevant parts - change wording to focus on the user needs

saig0 · 2024-08-05T12:52:59Z

@ce-dmelnych I pushed the changes from our review meeting today. 🚀

christinaausley

This is so clean and well documented! Great work 🚀

Should we also add this to the glossary?

- improve some wordings & formatting - fix broken links - add `Execution listener` term to glossary

ce-dmelnych · 2024-08-07T10:51:05Z

Thank you both for your valuable reviews and the improvements you committed to the documentation! 🙌

@saig0 , I appreciate the meeting and the suggestions you provided, which have greatly enhanced the clarity and effectiveness of the content 🙇‍♂️

@christinaausley, thank you for your positive feedback!
I’ve just pushed another commit with some small improvements to the wording and formatting, fixed a broken link, and added the Execution listener term to the glossary. Please review it to see if it aligns with your expectations.

Thanks again for your support and collaboration! 🚀

megglos · 2024-08-09T11:11:25Z

@saig0 @ce-dmelnych do you consider it doable to get this merged by Tuesday next week? Will include a link in the release blogpost then.

saig0 · 2024-08-09T11:33:24Z

@megglos yes. I'll review it on Monday.

saig0

LGTM. 🚀

github-actions · 2024-08-12T09:06:46Z

🧹 Preview environment for this PR has been torn down.

ce-dmelnych self-assigned this Jul 4, 2024

ce-dmelnych added the component:zeebe Issues related with Zeebe project label Jul 4, 2024

ce-dmelnych added the 8.6.0-alpha4 August 2024 alpha release label Jul 4, 2024

barmac mentioned this pull request Jul 4, 2024

Add support for execution listeners camunda/camunda-modeler#3951

Closed

17 tasks

ce-dmelnych added 2 commits July 4, 2024 12:11

Merge remote-tracking branch 'origin/feature/add-execution-listeners-…

d10fe1c

…doc' into feature/add-execution-listeners-doc # Conflicts: # docs/components/concepts/execution-listeners.md

This was referenced Jul 4, 2024

feat: support zeebe:ExecutionListener camunda/zeebe-bpmn-moddle#57

Merged

Support zeebe:ExecutionListener camunda/camunda-bpmn-js-behaviors#76

Merged

ce-dmelnych added 2 commits July 9, 2024 16:03

Merge branch 'refs/heads/main' into feature/add-execution-listeners-doc

7e3a07a

docs(concepts): improve documentation

11199d6

- adjust text for sections - improve formatting - add sections with limitations and workarounds

ce-dmelnych requested review from saig0 and christinaausley July 9, 2024 13:21

ce-dmelnych marked this pull request as ready for review July 9, 2024 13:21

ce-dmelnych linked an issue Jul 9, 2024 that may be closed by this pull request

Setup Execution Listener documentation camunda/camunda#16219

Closed

ce-dmelnych added the deploy Stand up a temporary docs site with this PR label Jul 9, 2024

github-actions bot temporarily deployed to camunda-docs July 9, 2024 13:44 Destroyed

Merge branch 'refs/heads/main' into feature/add-execution-listeners-doc

27b6070

github-actions bot temporarily deployed to camunda-docs July 29, 2024 06:56 Destroyed

saig0 requested changes Aug 2, 2024

View reviewed changes

docs(concepts): Improve Execution Listener concept

1c79d70

- restructure content - remove not relevant parts - change wording to focus on the user needs

style(formatting): technical review

21ea0fd

christinaausley previously approved these changes Aug 5, 2024

View reviewed changes

Merge branch 'main' into feature/add-execution-listeners-doc

da5e76c

ce-dmelnych added 2 commits August 7, 2024 12:47

Merge branch 'refs/heads/main' into feature/add-execution-listeners-doc

fc4292b

docs(concepts): improve documentation

09ad10e

- improve some wordings & formatting - fix broken links - add `Execution listener` term to glossary

ce-dmelnych dismissed christinaausley’s stale review via 09ad10e August 7, 2024 09:48

github-actions bot temporarily deployed to camunda-docs August 7, 2024 10:05 Destroyed

ce-dmelnych requested review from saig0 and christinaausley August 7, 2024 10:51

christinaausley approved these changes Aug 7, 2024

View reviewed changes

saig0 approved these changes Aug 12, 2024

View reviewed changes

saig0 merged commit 9f270a7 into main Aug 12, 2024
9 checks passed

saig0 deleted the feature/add-execution-listeners-doc branch August 12, 2024 09:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(concepts): Add documentation for Execution Listeners #4017

docs(concepts): Add documentation for Execution Listeners #4017

ce-dmelnych commented Jul 4, 2024 •

edited

Loading

github-actions bot commented Jul 4, 2024 •

edited

Loading

christinaausley commented Jul 8, 2024

ce-dmelnych commented Jul 9, 2024 •

edited

Loading

github-actions bot commented Jul 9, 2024

christinaausley commented Jul 17, 2024

saig0 left a comment

saig0 commented Aug 5, 2024

christinaausley left a comment

ce-dmelnych commented Aug 7, 2024

megglos commented Aug 9, 2024

saig0 commented Aug 9, 2024

saig0 left a comment

github-actions bot commented Aug 12, 2024

docs(concepts): Add documentation for Execution Listeners #4017

docs(concepts): Add documentation for Execution Listeners #4017

Conversation

ce-dmelnych commented Jul 4, 2024 • edited Loading

Description

When should this change go live?

PR Checklist

github-actions bot commented Jul 4, 2024 • edited Loading

christinaausley commented Jul 8, 2024

ce-dmelnych commented Jul 9, 2024 • edited Loading

github-actions bot commented Jul 9, 2024

christinaausley commented Jul 17, 2024

saig0 left a comment

Choose a reason for hiding this comment

saig0 commented Aug 5, 2024

christinaausley left a comment

Choose a reason for hiding this comment

ce-dmelnych commented Aug 7, 2024

megglos commented Aug 9, 2024

saig0 commented Aug 9, 2024

saig0 left a comment

Choose a reason for hiding this comment

github-actions bot commented Aug 12, 2024

ce-dmelnych commented Jul 4, 2024 •

edited

Loading

github-actions bot commented Jul 4, 2024 •

edited

Loading

ce-dmelnych commented Jul 9, 2024 •

edited

Loading