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

Consolidate documentation refs in element templates #189

Closed
tmetzke opened this issue Jan 10, 2023 · 5 comments
Closed

Consolidate documentation refs in element templates #189

tmetzke opened this issue Jan 10, 2023 · 5 comments
Assignees
Labels
kind:task Categorizes an issue or PR as general maintenance, i.e. cleanup, refactoring, etc. scope:bundle

Comments

@tmetzke
Copy link
Member

tmetzke commented Jan 10, 2023

What should we do?

Adjust the documentationRef attributes in the element templates of all Connectors to point to https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/ plus their respective documentation context path.

Why should we do it?

All element templates use different documentation refs like

  • https://docs.camunda.io/docs/next/components/connectors/out-of-the-box-connectors/XYZ
  • https://docs.camunda.io/docs/components/modeler/web-modeler/connectors/available-connectors/XYZ
  • https://docs.camunda.io/docs/components/integration-framework/connectors/out-of-the-box-connectors/XYZ
@tmetzke tmetzke added kind:task Categorizes an issue or PR as general maintenance, i.e. cleanup, refactoring, etc. scope:bundle labels Jan 10, 2023
@bastiankoerber
Copy link

needs to validated

@sbuettner
Copy link
Contributor

@Oleksiivanov Did you work on this? Is it open or can we consider it closed?

@Oleksiivanov
Copy link
Contributor

@Oleksiivanov Did you work on this? Is it open or can we consider it closed?

yes, we already did it. but I recheck it again, and will add a comment

@Oleksiivanov
Copy link
Contributor

rechecked :

https://docs.camunda.io/docs/next/components/connectors/out-of-the-box-connectors/XYZ
https://docs.camunda.io/docs/components/modeler/web-modeler/connectors/available-connectors/XYZ
https://docs.camunda.io/docs/components/integration-framework/connectors/out-of-the-box-connectors/XYZ

uses only in the deprecated template versions, that are already not available.

All available templates (with latest version) use https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/ format for documentationRef

@tmetzke, I believe there's no need to modify the documentationRef in the deprecated templates since they are no longer available. We are planning to remove these templates from the modeler as per this GitHub issue: https://github.com/camunda/product-hub/issues/1900. So can we close this ticket?

@tmetzke
Copy link
Member Author

tmetzke commented Jan 17, 2024

Sounds good to me, @Oleksiivanov 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:task Categorizes an issue or PR as general maintenance, i.e. cleanup, refactoring, etc. scope:bundle
Projects
None yet
Development

No branches or pull requests

4 participants