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-initial-element-template-link-check-file #5090

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 134 additions & 0 deletions connectors-element-template-links.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
# This file contains links from connectors element templates to the documentation
# This file is used to check that we don't accidentally break these links

https://docs.camunda.io/docs
https://docs.camunda.io/docs/8.6/components/connectors/out-of-the-box-connectors/amazon-sagemaker
https://docs.camunda.io/docs/8.6/components/connectors/out-of-the-box-connectors/amazon-textract
https://docs.camunda.io/docs/8.6/components/connectors/out-of-the-box-connectors/sql
https://docs.camunda.io/docs/8.6/components/connectors/out-of-the-box-connectors/sql/#connection
https://docs.camunda.io/docs/8.6/components/connectors/out-of-the-box-connectors/sql/#uri-connection
https://docs.camunda.io/docs/8.6/components/connectors/out-of-the-box-connectors/sql/#variables
https://docs.camunda.io/docs/8.7/apis-tools/camunda-api-rest/specifications/create-document-link/
https://docs.camunda.io/docs/8.7/components/connectors/out-of-the-box-connectors/amazon-comprehend
https://docs.camunda.io/docs/apis-clients/operate-api/#filter
https://docs.camunda.io/docs/apis-clients/operate-api/#sort
https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/upload-document-alpha/
https://docs.camunda.io/docs/apis-tools/operate-api/specifications/search
https://docs.camunda.io/docs/apis-tools/operate-api/specifications/search/
https://docs.camunda.io/docs/components/concepts/messages/#message-correlation-overview
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-bedrock
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-dynamodb
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-dynamodb/
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge/?awseventbridge=inbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge/?awseventbridge=outbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-s3
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sns/
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sns/?amazonsns=inbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sns/?amazonsns=outbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sqs/
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sqs/?amazonsqs=inbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/amazon-sqs/?amazonsqs=outbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/asana
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/automation-anywhere
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/automation-anywhere/
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-dynamodb
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-dynamodb/
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-eventbridge
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-eventbridge/
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-eventbridge-webhook
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-lambda
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-lambda/
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-lambda/#aws-authentication-types
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sns
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sns-inbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sqs
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sqs-inbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/aws-sqs-inbound/
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/azure-open-ai
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/blueprism
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/box
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/easy-post
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/email
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/github
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/github/?github=inbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/github/?github=outbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/github-webhook
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/googledrive
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/google-gemini
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/google-maps-platform
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/google-sheets
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/google-sheets/#add-values-to-spreadsheet
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/google-sheets/#create-empty-column-or-row
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/google-sheets/#create-row
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/google-sheets/#how-can-i-define-which-column-will-be-deleted
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/google-sheets/#what-is-a-row-index
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/google-sheets/#what-is-a-worksheet-index
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/graphql
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/graphql/#querymutation
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/graphql/#variables
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/http-webhook
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/http-webhook/
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/hugging-face
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/kafka
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/kafka-inbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/kafka/?kafka=inbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/kafka/?kafka=outbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/microsoft-o365-mail
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/microsoft-teams
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/openai
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/operate
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/power-automate
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/power-automate/#oauth-token-endpoint
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/rabbitmq
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/rabbitmq-inbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/rabbitmq/?rabbitmq=inbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/rabbitmq/?rabbitmq=inbound#routing-data-1
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/rabbitmq/?rabbitmq=outbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/rabbitmq/?rabbitmq=outbound#routing-data
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/rabbitmq/#routing-data
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/rest
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/salesforce
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/sendgrid
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/slack
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/slack-inbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/slack/?slack=inbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/slack/?slack=outbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/twilio
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/twilio/
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/twilio/?twilio=inbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/twilio/?twilio=outbound
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/twilio-webhook
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/uipath
https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/whatsapp
https://docs.camunda.io/docs/components/connectors/protocol/amazon-eventbridge/?awseventbridge=inbound
https://docs.camunda.io/docs/components/connectors/protocol/amazon-eventbridge/?awseventbridge=outbound
https://docs.camunda.io/docs/components/connectors/protocol/aws-lambda/#aws-authentication-types
https://docs.camunda.io/docs/components/connectors/protocol/graphql
https://docs.camunda.io/docs/components/connectors/protocol/graphql/#querymutation
https://docs.camunda.io/docs/components/connectors/protocol/http-webhook
https://docs.camunda.io/docs/components/connectors/protocol/polling
https://docs.camunda.io/docs/components/connectors/protocol/rest
https://docs.camunda.io/docs/components/connectors/protocol/soap
https://docs.camunda.io/docs/components/connectors/use-connectors/
https://docs.camunda.io/docs/components/connectors/use-connectors/#bpmn-errors
https://docs.camunda.io/docs/components/connectors/use-connectors/#result-expression
https://docs.camunda.io/docs/components/connectors/use-connectors/#result-variable
https://docs.camunda.io/docs/components/modeler/bpmn/none-events
https://docs.camunda.io/docs/components/modeler/desktop-modeler/element-templates/using-templates/#replacing-templates
https://docs.camunda.io/docs/components/modeler/web-modeler/camunda-marketplace
https://docs.camunda.io/docs/components/modeler/web-modeler/connectors/available-connectors/automation-anywhere/
https://docs.camunda.io/docs/components/modeler/web-modeler/connectors/available-connectors/rest
https://docs.camunda.io/docs/components/modeler/web-modeler/connectors/available-connectors/sendgrid
https://docs.camunda.io/docs/guides
https://docs.camunda.io/docs/guides/setup-client-connection-credentials
https://docs.camunda.io/docs/next/apis-tools/camunda-api-rest/specifications/create-document-link/
https://docs.camunda.io/docs/next/components/connectors/out-of-the-box-connectors/amazon-comprehend
https://docs.camunda.io/docs/next/components/connectors/out-of-the-box-connectors/amazon-sagemaker
https://docs.camunda.io/docs/next/components/connectors/out-of-the-box-connectors/amazon-textract
https://docs.camunda.io/docs/next/components/connectors/out-of-the-box-connectors/aws-dynamodb/
https://docs.camunda.io/docs/next/components/connectors/out-of-the-box-connectors/aws-eventbridge/
https://docs.camunda.io/docs/next/components/connectors/out-of-the-box-connectors/sql
https://docs.camunda.io/docs/next/components/connectors/out-of-the-box-connectors/sql/#connection
https://docs.camunda.io/docs/next/components/connectors/out-of-the-box-connectors/sql/#uri-connection
https://docs.camunda.io/docs/next/components/connectors/out-of-the-box-connectors/sql/#variables
https://docs.camunda.io/docs/next/guides/setup-client-connection-credentials
Comment on lines +124 to +134
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are all links to the /next version. A few questions:

  1. Are they linking to /next intentionally?
  2. If they aren't intentionally linking to /next, can they be changed to the current version?
  3. If they're intentionally linking to /next (presumably because they don't exist in any version except next), could they link to a specific version number instead of /next? We don't currently have a rule to redirect /8.8 URLs to /next, but I think I would prefer adding one over preserving /next links via redirect rules.

Some background:

We don't usually worry about preserving redirects for /next docs, because we consider that area of the docs to be very fluid and undergoing change. To preserve these links would be an unusual thing for us to do, and I want to make sure they are the correct links before we commit to doing that.

Copy link
Contributor Author

@ztefanie ztefanie Feb 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for reviewing and this input. I am not super sure how to handle this.

To answer your questions:

  1. Some are linking to next intentionally, but some are not.
  2. We can change the latest versions of our element templates, but not really older ones, as they have be downloaded and are on different systems, e.g. on customers system where they have been downloaded to.
  3. For the latest versions of the element templates I can adjust this and replace next with 8.8

So what we can do is:

A) Add a check to a github action in our/connectors repo, that no links with /next/ are in future element templates.
B) Fix links in the latest element templates to not link to next
Both (A+B) will require on your side that links to 8.8 are working, not like now, where they return 404. If i understand you correctly, that is what you suggested.
C) Older templates cannot be fixed and need either a redirect on your side, or if you do not want to this, will stay broken, but with A and B, this will "fade out" in the future, when customers update their element templates, but I would prefer them to be redirected and be working right away, but that's up to you.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, makes sense, and I agree on all points!

  • I will let you know when I've got /8.8 links redirecting properly, so you can move forward on your end.
  • I will add redirects for the few /next links that need them when I get the CI workflow properly checking these links, which I'll do on this PR.

Copy link
Contributor Author

@ztefanie ztefanie Mar 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I completed the tasks on our side in this PR (replacing next links in current element templates and adding a ci check for avoiding future linking to /next/). No links that linked to next where only available on 8.8 so i changed them to link to 8.7 or where possible to 8.6.

Loading