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

Add inbound boundary event to documentation #4343

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

mathias-vandaele
Copy link
Contributor

Description

The description of inbound boundary event was undocumented.

This fixes it.

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 Sep 24, 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.

@akeller akeller added the component:connectors Issues related to the connectors project. label Sep 24, 2024
@akeller akeller requested review from sbuettner and a team September 24, 2024 15:52
Comment on lines +463 to +469
<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",
Copy link
Contributor

@sbuettner sbuettner Sep 25, 2024

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.

Copy link
Member

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?

Copy link
Contributor

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)
Copy link
Contributor

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.

@akeller
Copy link
Member

akeller commented Sep 27, 2024

Does this need to be backported?

@mathias-vandaele
Copy link
Contributor Author

@akeller Yes i think so, as it was missing from the documentation.

It can also be merged

@mathias-vandaele mathias-vandaele linked an issue Oct 3, 2024 that may be closed by this pull request
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.

@mathias-vandaele Can you resolve the comments from @sbuettner here, and I will backport and merge for you?

@mathias-vandaele
Copy link
Contributor Author

mathias-vandaele commented Oct 4, 2024

@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?

@christinaausley
Copy link
Contributor

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:connectors Issues related to the connectors project.
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

Add Example for Boundary Event Connector Templates
4 participants