-
Notifications
You must be signed in to change notification settings - Fork 182
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
Add inbound boundary event to documentation #4343
base: main
Are you sure you want to change the base?
Add inbound boundary event to documentation #4343
Conversation
… boundary events 2
👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉 You can read more about the versioning within our docs in our documentation guidelines. |
<TabItem value='json'> | ||
|
||
```json | ||
{ | ||
"$schema": "https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json", | ||
"name": "Webhook Boundary Event Connector", | ||
"id": "io.camunda.connectors.webhook.WebhookConnectorBoundary.v1", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should rather link to the marketplace than including the element template here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this still an open topic?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Based on discussion with @mathias-vandaele and @sbuettner, I have added an admonition at the top of the page with a link to Marketplace. I have also backported this, though they may have additional changes based on casing for the elements in this PR.
|
||
<TabItem value='process'> | ||
|
||
![Webhook Inbound boundary Connector Example.png](img/custom-connector-template-inbound-boundary.png) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The example is a little bit unclear as it doesnt contain any labels. I would also recommend to only use a single connector in the example. The one that is used for the boundary event. Please also describe how the Connector is used in this example like: Using Connectors as Boundary Events allows to receive messages while another activity is executing or waiting.
I would therefore recommend to model is with a user task which gets interrupted for example.
Does this need to be backported? |
@akeller Yes i think so, as it was missing from the documentation. It can also be merged |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mathias-vandaele Can you resolve the comments from @sbuettner here, and I will backport and merge for you?
@christinaausley I have made the modification in response to @sbuettner's second comment, concerning the first comment, which involves removing all the XML present in this file and eliminating the tab system for coherence. How should we then include the marketplace link? |
@mathias-vandaele @sbuettner Per our discussion on Slack, I have added an admonition at the top of the page with a link to Marketplace. I have also backported this for you -- if you have any additional changes you can make these in this PR or a separate PR, but I am approving from a TW perspective. |
Description
The description of inbound boundary event was undocumented.
This fixes it.
When should this change go live?
hold
label or convert to draft PR)PR Checklist
/versioned_docs
directory./docs
directory (aka/next/
).