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

Document changes #4005

Closed
1 task done
Tracked by #4003
danielkelemen opened this issue Dec 11, 2023 · 2 comments
Closed
1 task done
Tracked by #4003

Document changes #4005

danielkelemen opened this issue Dec 11, 2023 · 2 comments
Assignees
Labels
scope:documentation Changes to the product documentation. type:subtask Issues that are subtasks of another issue. Must always be part of the breakdown of the parent issue. version:7.21.0

Comments

@danielkelemen
Copy link
Member

danielkelemen commented Dec 11, 2023

Acceptance Criteria (Required on creation)

  • New engine config is documented.
  • Job executor -> Exclusive jobs page is updated.

Hints

Links

Breakdown

camunda-docs-manual PR

  1. psavidis
@danielkelemen danielkelemen added type:subtask Issues that are subtasks of another issue. Must always be part of the breakdown of the parent issue. scope:documentation Changes to the product documentation. potential:7.21.0 labels Dec 11, 2023
@psavidis psavidis self-assigned this Mar 5, 2024
psavidis added a commit to camunda/camunda-docs-manual that referenced this issue Mar 13, 2024
Context: Configuration Properties
What: New Property `jobExecutorAcquireExclusiveOverProcessHierarchies`

Related-to: camunda/camunda-bpm-platform#4005
psavidis added a commit to camunda/camunda-docs-manual that referenced this issue Mar 13, 2024
What:

- Property `jobExecutorAcquireExclusiveOverProcessHierarchies` is added to Configuration Properties
    - Short description of what it controls
    - Values range
    - Link to related user guide section

- New Section for Exclusive Jobs of Process Hierarchies is added after Exclusive Jobs
    - Links to Configuration Property

- Image (img) that depicts the case where exclusiveness won't be guaranteed for the cases of process hierarchies

Related-to: camunda/camunda-bpm-platform#4005
psavidis added a commit to camunda/camunda-docs-manual that referenced this issue Mar 14, 2024
What:

- Property `jobExecutorAcquireExclusiveOverProcessHierarchies` is added to Configuration Properties
    - Short description of what it controls
    - Values range
    - Link to related user guide section

- New Section for Exclusive Jobs of Process Hierarchies is added after Exclusive Jobs
    - Links to Configuration Property

- Image (img) that depicts the case where exclusiveness won't be guaranteed for the cases of process hierarchies

Related-to: camunda/camunda-bpm-platform#4005
@psavidis
Copy link
Contributor

Notes for the Reviewer

Documentation Changes

  • Added new section Exclusive Jobs of Process Hierarchies
    • Explains the current behaviour of the exclusive keyword when it comes to subprocesses
    • The need for exclusiveness over subprocesses
    • The default configuration
    • A warning note serving as a reminder to the reader that the activation of the feature might have performance implications for complex process models
  • Added the new jobExecutorAcquireExclusiveOverProcessHierarchies property under the Configuration Properties section.
    • Also link to the newly added section Exclusive Jobs of Process Hierarchies next to the Exclusive Jobs .

@psavidis psavidis assigned yanavasileva and unassigned psavidis Mar 15, 2024
psavidis added a commit to camunda/camunda-docs-manual that referenced this issue Mar 22, 2024
Context: Documentation on the following:

- How exclusive jobs of process hierarchies behave by default
- The feature that enables exclusive execution over hierarchies
- New feature flag configuration

The commit adds an image(png) that demonstrates the limited application of `exclusive` on a hierarchical process setup.

Co-authored-by: yanavasileva
Co-authored-by: petros.savvidis

Related-to:
- camunda/camunda-bpm-platform#4003
- camunda/camunda-bpm-platform#4005
@psavidis
Copy link
Contributor

Merged documentation to master. Closing this task.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope:documentation Changes to the product documentation. type:subtask Issues that are subtasks of another issue. Must always be part of the breakdown of the parent issue. version:7.21.0
Projects
None yet
Development

No branches or pull requests

4 participants