camunda / connectors

Camunda Connectors
https://docs.camunda.io/docs/components/integration-framework/connectors/out-of-the-box-connectors/available-connectors-overview/
Apache License 2.0
39 stars 38 forks source link

Update template descriptions and add keywords to improve refactorings suggestions #3089

Open philippfromme opened 1 month ago

philippfromme commented 1 month ago

What should we do?

The ✨ feature for selected elements in Web Modeler suggests connectors based on an element's name. The suggestions are based on the name and description of the connector templates and therefore the quality of suggestions depends on those.

image

The latest version of the ✨ also takes into account keywords that were added to a template. For example, the following template

{
  "$schema": "https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json",
  "name": "Twitter Connector",
  "id": "io.camunda.connectors.Twitter",
  "version": 1,
  "description": "Post and manage tweets on Twitter",
  "metadata": {
    "keywords": [
      "create tweet",
      "delete tweet",
      "quote tweet",
      "reply to tweet",
      "retweet"
    ]
  },
  "category": {
    "id": "connectors",
    "name": "Connectors"
  },
  "appliesTo": [
    "bpmn:Task"
  ],
  "properties": []
}

has a keywords field with relevant keywords. If an element's name mentions replying to a tweet the connector will be suggested based on the matching keyword.

Why should we do it?

To improve the quality of suggestions.

Related to https://github.com/bpmn-io/refactorings/pull/27

philippfromme commented 1 week ago

@chillleader @Oleksiivanov @igpetrov What is the source of truth for element template descriptions? I couldn't find anything other than the templates themselves?

YanaSegal commented 3 days ago

@philippfromme depends where:

philippfromme commented 3 days ago

Yes, I'm talking about the templates themselves. But since they are generated I was wondering where the descriptions are coming from and who is responsible for them.

YanaSegal commented 3 days ago

The template creator is responsible for providing the description.