Document Connector Templates and their use in Web Modeler

wollefitz commented 1 year ago

Connector Templates are a powerful feature which also comes with a certain level of complexity. We should create a dedicated page for "Connector Templates and their use in Web Modeler" which explain the concepts and use-cases around connector templates in addition to/as replacement for the existing pages that focus on more administrative aspects like managing connector templates in Web Modeler.

The user should be able to understand how they can use the templates in both Web Modeler SaaS and Web Modeler Self-Managed.

Goal

Add a new page "Connector Templates and their use in Web Modeler":

Explain how to use connector templates in Web Modeler, analogous to https://docs.camunda.io/docs/components/modeler/desktop-modeler/element-templates/using-templates/
Explain differences between SaaS and Self-Managed
For Self-Managed there is a clearly described compatibility matrix so as a User I know which OOTB Connectors I can use with which Web Modeler Self-Managed version
Consider moving the documentation about element templates schema and editor https://docs.camunda.io/docs/components/modeler/desktop-modeler/element-templates/about-templates/ outside the Desktop Modeler space and make it a general modeler concern
Explain the implications of the element template lifecycle (see for example https://github.com/camunda/web-modeler/issues/5611 for a common pitfall of the lifecycle)

Todo

align with Desktop Modeler team
align with Connectors team

CatalinaMoisuc commented 1 year ago

FYI, @barmac is working on some changes in templates docs now as well: https://github.com/bpmn-io/internal-docs/issues/663.

But as discussed, there is no capacity yet this iteration, we have to leave it for the next one.

CatalinaMoisuc commented 1 year ago

Update

There is no capacity to pick this up at the moment due to FTOs, some are already on FTO, some busy with the next release, some with closing items before they leave for 2-weeks FTO.

CatalinaMoisuc commented 1 year ago

@CatalinaMoisuc to discuss this with Simon.

CatalinaMoisuc commented 1 year ago

@sbuettner as mentioned in the sync today,

Within the mindset of Web Modeler as a Platform, I would like to delegate the ownership of the documentation of how to use Connectors in Web Modeler to the Connectors team.

I think documentation is a good first step. This is a good chance:

for the Connectors team to revisit their knowledge of all the Connectors use-cases/User Journeys and how they work within the Web Modeler => ownership
to clarify also compatibility between the OOTB Connectors / Marketplace Connectors and Web Modeler Self-Managed in the documentation => compatibility matrix
to switch/delegate responsibilities for all Connectors documentation - even within the Web Modeler context - to the Web Modeler => handover/ownership

@sbuettner I assigned this documentation issue to you and your team to drive when you have enough capacity and you can reach out/follow up for any support that my team can offer to complete it. Always happy to help!

sbuettner commented 12 months ago

@bastiankoerber about to asses this topic.

wollefitz commented 4 months ago

Reassigning to @crobbins215 who has ownership of connectors at the moment.

This topic gained a bit more traction again via https://github.com/camunda/camunda-docs/pull/3420#issuecomment-2058843530, see Slack conversation.

camunda / camunda-docs