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 user task listeners for user task modeling #4814

Merged
merged 3 commits into from
Jan 9, 2025

Conversation

ce-dmelnych
Copy link
Contributor

@ce-dmelnych ce-dmelnych commented Jan 2, 2025

Description

Scope:

  • added subsection on how to define user task listeners.
  • linked with the User task listeners concept page.
  • provided an XML example for the user task with the defined user task listeners.

These changes were made together by @ana-vinogradova-camunda and @ce-dmelnych so they don't require additional Engineering review. A Technical writer review is appreciated.

closes camunda/camunda#26343

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

Copy link
Contributor

github-actions bot commented Jan 2, 2025

👋 🤖 🤔 Hello, @ce-dmelnych! 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.6/.

  • docs/components/modeler/bpmn/user-tasks/user-tasks.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.

@ce-dmelnych ce-dmelnych requested a review from a team January 2, 2025 14:30
@ce-dmelnych ce-dmelnych added the 8.7.0-alpha3 January 2024 alpha release label Jan 2, 2025
@ce-dmelnych ce-dmelnych linked an issue Jan 2, 2025 that may be closed by this pull request
@ce-dmelnych ce-dmelnych marked this pull request as ready for review January 2, 2025 14:34
@ce-dmelnych ce-dmelnych changed the title docs: Document user task listeners for user task modeling Document user task listeners for user task modeling Jan 3, 2025
@korthout korthout self-requested a review January 7, 2025 15:26
christinaausley
christinaausley previously approved these changes Jan 7, 2025
Copy link
Contributor

@christinaausley christinaausley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From a technical perspective, this is very clean writing! Nice work.

korthout
korthout previously approved these changes Jan 7, 2025
Copy link
Member

@korthout korthout left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

🔧 I have a few small suggestions though

docs/components/modeler/bpmn/user-tasks/user-tasks.md Outdated Show resolved Hide resolved
docs/components/modeler/bpmn/user-tasks/user-tasks.md Outdated Show resolved Hide resolved
@ce-dmelnych ce-dmelnych force-pushed the 26342-user-task-listeners-concept branch 2 times, most recently from 89a871f to e60a7b0 Compare January 9, 2025 11:46
@ce-dmelnych ce-dmelnych force-pushed the 26343-document-user-task-listeners-modeling branch from c3474cb to c42b539 Compare January 9, 2025 14:11
Base automatically changed from 26342-user-task-listeners-concept to main January 9, 2025 17:36
@ce-dmelnych ce-dmelnych dismissed stale reviews from korthout and christinaausley January 9, 2025 17:36

The base branch was changed.

ce-dmelnych and others added 3 commits January 9, 2025 20:01
Scope:
- added subsection on how to define user task listeners.
- linked with the `User task listeners` concept page.
- provided an XML example for the user task with the defined user task listeners.

Co-authored-by: Ana Vinogradova <[email protected]>
- making user task listeners description language agnostic
- using `attributes` instead of `properties` in configuration
@ce-dmelnych ce-dmelnych force-pushed the 26343-document-user-task-listeners-modeling branch from c42b539 to d251804 Compare January 9, 2025 18:02
@ce-dmelnych ce-dmelnych merged commit f66cf3c into main Jan 9, 2025
8 checks passed
@ce-dmelnych ce-dmelnych deleted the 26343-document-user-task-listeners-modeling branch January 9, 2025 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.7.0-alpha3 January 2024 alpha release
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Document the task listeners for user task modeling
4 participants