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 test external links in docs on a regular basis #11943

Closed
webvictim opened this issue Apr 14, 2022 · 2 comments
Closed

Automatically test external links in docs on a regular basis #11943

webvictim opened this issue Apr 14, 2022 · 2 comments
Labels
documentation feature-request Used for new features in Teleport, improvements to current should be #enhancements

Comments

@webvictim
Copy link
Contributor

As #11940 is removing external link checking on every PR due to false positives, we should come up with some other way to test external links in the docs on a semi-regular basis (I propose doing so daily).

Couple of options:

  1. Some kind of cron job in Drone/GCB to run nightly and alert somewhere on failures
  2. I think we already have an external service that monitors our website as a whole and reports back on SEO and other factors. Maybe this could also check links in the docs to make sure they resolve correctly?
@webvictim webvictim added documentation feature-request Used for new features in Teleport, improvements to current should be #enhancements labels Apr 14, 2022
@ptgott
Copy link
Contributor

ptgott commented May 18, 2022

I'm going to work on nudging this toward a more specific plan in the next sprint. In the meantime, CCing @C-STYR and @jeffgaynor—it'd be great to get your thoughts on this. Thanks!

@ptgott
Copy link
Contributor

ptgott commented May 31, 2022

I've talked to @C-STYR and @jeffgaynor on the Web team. We are currently using Semrush to manually check for 404ing external links on our production docs site on a weekly basis. The Web team will look for ways to check external links in a more automated fashion and for pre-production changes, but we're treating this as a low-priority issue since we have an existing solution.

@ptgott ptgott closed this as completed May 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation feature-request Used for new features in Teleport, improvements to current should be #enhancements
Projects
None yet
Development

No branches or pull requests

2 participants