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

Automatically verify links in OTel README file #5117

Closed
andrzej-stencel opened this issue Jul 11, 2024 · 2 comments · Fixed by #5443
Closed

Automatically verify links in OTel README file #5117

andrzej-stencel opened this issue Jul 11, 2024 · 2 comments · Fixed by #5443
Assignees
Labels
docs enhancement New feature or request good first issue Good for newcomers

Comments

@andrzej-stencel
Copy link
Contributor

andrzej-stencel commented Jul 11, 2024

          it looks good, i was wondering if we should do some kind of validation to check remote part exists, but this could be problematic in CI in case if there are traffic filters.

Originally posted by @michalpristas in #5087 (review)

The OTel README file has links to components that are created automatically by the mage otel:readme command. We should have a tool to automatically check that the links are valid (point to something that exists).

We could use https://github.com/tcort/markdown-link-check/ or similar solution for this.

@ycombinator ycombinator added enhancement New feature or request good first issue Good for newcomers docs labels Jul 11, 2024
@ycombinator ycombinator changed the title [CI] Automatically verify links in OTel README file Automatically verify links in OTel README file Jul 16, 2024
@ycombinator
Copy link
Contributor

ycombinator commented Jul 16, 2024

The OTel README file has links to components that are created automatically by the mage otel:readme command. We should have a tool to automatically check that the links are valid (point to something that exists).

Would it make sense for mage otel:readme to itself to perform this check before it creates the links? Additionally, it might be good for mage check to perform the same check as well, in case links that used to work at creation time have since stopped working for some reason.

@mauri870
Copy link
Member

A pure Go alternative that we can use is https://github.com/rednafi/link-patrol.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants