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 github action for broken link check in connectors element templates #4992

Conversation

ztefanie
Copy link
Contributor

@ztefanie ztefanie commented Feb 13, 2025

Description

This PR is related to this issue: https://github.com/camunda/team-connectors/issues/889
The solution suggested is a monthly running job, checking with docusaurus build for incorrect links inside the element templates of connectors.

An issue created by this looks like this: #4995

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support. (add bug or support label)
  • This is already available but undocumented and should be released within a week. (add available & undocumented label)
  • This is on a specific schedule and the assignee will coordinate a release with the DevEx team. (create draft PR and/or add hold label)
  • This is part of a scheduled alpha or minor. (add alpha or minor label)
  • There is no urgency with this change (add low prio label)

PR Checklist

  • My changes are for an upcoming minor release and:
    • are in the /docs directory (version 8.8).
    • are in the /versioned_docs/version-8.7/ directory (version 8.7).
  • My changes are for an already released minor and are in a /versioned_docs directory.

@ztefanie ztefanie force-pushed the add-github-action-for-broken-link-check-in-connectors-element-templates branch 8 times, most recently from 382b430 to 647b780 Compare February 13, 2025 09:03
Copy link
Contributor

github-actions bot commented Feb 13, 2025

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

@ztefanie ztefanie force-pushed the add-github-action-for-broken-link-check-in-connectors-element-templates branch from 647b780 to 71704d3 Compare February 13, 2025 09:03
@ztefanie ztefanie requested a review from pepopowitz February 13, 2025 09:16
@ztefanie ztefanie force-pushed the add-github-action-for-broken-link-check-in-connectors-element-templates branch from 71704d3 to 0f3ff9d Compare February 13, 2025 09:20
@ztefanie ztefanie marked this pull request as ready for review February 13, 2025 09:20
@akeller akeller added dx Documentation infrastructure typically handled by the Camunda DX team low prio There is no urgency with this change. labels Feb 13, 2025
@ztefanie ztefanie force-pushed the add-github-action-for-broken-link-check-in-connectors-element-templates branch from 0f3ff9d to ccb2da7 Compare February 14, 2025 08:48
@sbuettner
Copy link
Contributor

@ztefanie Please check this comment before merging this here: https://github.com/camunda/team-connectors/issues/889#issuecomment-2659404853

Copy link
Collaborator

@pepopowitz pepopowitz left a comment

Choose a reason for hiding this comment

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

I have multiple concerns about accepting this PR. Among them: (1) It seems like a lot of complexity for the docs to take on for changes that will be occurring in the connectors repo (if I'm understanding the workflow correctly); (2) We already have multiple versions of link-checking, and I'd like to see if we can make one of them work before introducing another.

I'd like to talk about this PR in person. I'm going to send a calendar invite to @akeller, @ztefanie, @sbuettner, and @mesellings to discuss.

@pepopowitz
Copy link
Collaborator

As discussed in person, we're going to take a different approach on this, summarized below:

  1. @ztefanie will push up a PR with a new file similar to productlinks.txt, containing links referenced by connector templates.
  2. I will confirm that the product link validation is functioning properly for both anchors & redirects
  3. I will alter our CI workflows to validate links in the new file
  4. 🎉

@pepopowitz pepopowitz closed this Feb 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dx Documentation infrastructure typically handled by the Camunda DX team low prio There is no urgency with this change.
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

4 participants