Provide a more useful message when I use the wrong secret format

[CatalinaMoisuc]

What should we do?

We should give the user a more helpful error message when they encounter issues when using secrets.

This was reported by multiple people in internal channels over the past few days. See here and here.

This seems to be related to the switch to the mustache-style format when using secrets:
https://docs.camunda.io/docs/components/connectors/use-connectors/#using-secrets

The current error we show when people use the old secrets format is the following:

To mitigate this, we could add a link to the documentation page that explains how people can use the secrets correctly:
https://docs.camunda.io/docs/components/connectors/use-connectors/#using-secrets

Why should we do it?

To avoid confusion and ensure that our users are supported to quickly understand how they can fix the underlying issue.

[philippfromme]

Related to camunda/bpmnlint-plugin-camunda-compat#133. What's missing is being able to show warnings instead of errors in the properties panel and to add the link to documentation.

[nikku]

Discussed today morning:

• Let's not indicate warnings (or info) in the properties panel as an initial step. Instead keep them on the canvas + in the problems panel, and only focus the respective entry in the properties panel.

[CatalinaMoisuc]

@philippfromme since you have the correct context on this issue, I will assign this one to you as a candidate for the next iteration. Let's ensure that we get a new PR that fixes the UX.

[CatalinaMoisuc]

We can help the Connectors team to contribute with this. 😃

[philippfromme]

This requires two adjustments so we can ship it as part of @camunda/linting:

• enable the rule and change the category to info in bpmnlint-plugin-camunda-compat (feat(secrets): enable rule and report warn bpmnlint-plugin-camunda-compat#137)
• do not show properties panel error if category info or warn in ´@camunda/linting´