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 a tool to check for missing docs redirects #43351

Merged
merged 2 commits into from
Jun 25, 2024

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented Jun 21, 2024

Add a tool to check for URL paths in the Teleport docs site that do not correspond to actual docs pages or redirects. These URLs are most likely links that will 404 if a user follows them. This way, we can be more strategic about the redirects that we configure for the docs site, meaning that we do not need to add redirects for every single docs page that we rename or delete. A later change can add a GitHub Actions workflow to run the program.

Copy link

🤖 Vercel preview here: https://docs-p8urggj21-goteleport.vercel.app/docs/ver/preview

Add a tool to check for URL paths in the Teleport docs site that do not
correspond to actual docs pages or redirects. These URLs are most likely
links that will 404 if a user follows them. This way, we can be more
strategic about the redirects that we configure for the docs site,
meaning that we do not need to add redirects for every single docs page
that we rename or delete. A later change can add a GitHub Actions
workflow to run the program.
@ptgott ptgott force-pushed the paul.gottschling/2024-06-redirect-check branch from a550302 to bb61cbd Compare June 21, 2024 15:40
@ptgott ptgott changed the title Add a workflow to check for docs redirects Add a tool to check for docs redirects Jun 21, 2024
@ptgott ptgott changed the title Add a tool to check for docs redirects Add a tool to check for missing docs redirects Jun 21, 2024
@ptgott ptgott marked this pull request as ready for review June 21, 2024 15:41
Copy link

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

Copy link

🤖 Vercel preview here: https://docs-9hfwhdkz9-goteleport.vercel.app/docs/ver/preview

Copy link

🤖 Vercel preview here: https://docs-fesg8fcho-goteleport.vercel.app/docs/ver/preview

docs/check-redirects/check-redirects.js Outdated Show resolved Hide resolved
docs/check-redirects/check-redirects.js Outdated Show resolved Hide resolved
docs/check-redirects/check-redirects.js Outdated Show resolved Hide resolved
docs/check-redirects/check-redirects.js Outdated Show resolved Hide resolved
@ptgott

This comment was marked as resolved.

Copy link

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

Copy link
Contributor

@avatus avatus left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks

Copy link

🤖 Vercel preview here: https://docs-fo4b1732x-goteleport.vercel.app/docs/ver/preview

@ptgott ptgott added this pull request to the merge queue Jun 25, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jun 25, 2024
@ptgott ptgott added this pull request to the merge queue Jun 25, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jun 25, 2024
@avatus avatus added the no-changelog Indicates that a PR does not require a changelog entry label Jun 25, 2024
- Clarify the `--in` flag.
- Add a more descriptive name for missing directory entries.
- Explicitly check `docsURLs` length
- Use a Set for the internal redirects field
@ptgott ptgott force-pushed the paul.gottschling/2024-06-redirect-check branch from b53c3a0 to 144cfcd Compare June 25, 2024 17:32
@ptgott ptgott enabled auto-merge June 25, 2024 17:32
@ptgott ptgott added this pull request to the merge queue Jun 25, 2024
Copy link

🤖 Vercel preview here: https://docs-e5cs8k2ck-goteleport.vercel.app/docs/ver/preview

Merged via the queue into master with commit c27ff6a Jun 25, 2024
38 checks passed
@ptgott ptgott deleted the paul.gottschling/2024-06-redirect-check branch June 25, 2024 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation no-changelog Indicates that a PR does not require a changelog entry size/md
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants