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

Improve docs for correlation key for message start event #4336

Merged
merged 7 commits into from
Sep 26, 2024

Conversation

mesellings
Copy link
Contributor

@mesellings mesellings commented Sep 23, 2024

Description

This PR relates to and closes issue https://github.com/camunda/developer-experience/issues/378.

It relates to the bug raised: camunda/camunda-modeler#4466.

  • Added a note and some text edits to help clarify the documentation, as customer feedback indicates a misunderstanding is occurring about the correlation key.

Preview environment
https://preview.docs.camunda.cloud/pr-4336/docs/next/components/modeler/bpmn/message-events/

Note: There may be further work involved in this area of the docs (see camunda/camunda#2718) but this PR gets the clarifying note out as a first iteration.

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

@mesellings mesellings added kind/bug Issues related with bugs in the documentation component:docs Documentation improvements, including new or updated content hold This issue is parked, do not merge. deploy Stand up a temporary docs site with this PR labels Sep 23, 2024
@mesellings mesellings self-assigned this Sep 23, 2024
Copy link
Contributor

github-actions bot commented Sep 23, 2024

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

@github-actions github-actions bot temporarily deployed to camunda-docs September 23, 2024 15:14 Destroyed
@mesellings mesellings requested review from jwulf and a team September 23, 2024 15:24
@mesellings mesellings removed deploy Stand up a temporary docs site with this PR hold This issue is parked, do not merge. labels Sep 26, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs September 26, 2024 09:13 Destroyed
Copy link
Contributor

The preview environment relating to the commit 66823a0 has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4336/index.html

@mesellings mesellings merged commit 1f8534e into main Sep 26, 2024
9 of 11 checks passed
@mesellings mesellings deleted the mes-4466-correlationkey-message-start-event branch September 26, 2024 12:16
pepopowitz pushed a commit that referenced this pull request Oct 16, 2024
* TW edits: Note and formatting

* suggested edit (#4251)

* Add correlation heading

* Fix admonition

* Backport 8.5 to 1.3

---------

Co-authored-by: Josh Wulf <josh.wulf@camunda.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content kind/bug Issues related with bugs in the documentation
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants