-
Notifications
You must be signed in to change notification settings - Fork 198
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
ztefanie
wants to merge
2
commits into
main
Choose a base branch
from
add-initial-element-template-link-check-file
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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:/next
intentionally?/next
, can they be changed to the current version?/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.There was a problem hiding this comment.
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:
next
intentionally, but some are not.next
with8.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.
There was a problem hiding this comment.
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!
/8.8
links redirecting properly, so you can move forward on your end./next
links that need them when I get the CI workflow properly checking these links, which I'll do on this PR.There was a problem hiding this comment.
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.