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 workflow to check docs URLs #291

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented Nov 11, 2024

Like the workflow to check for necessary redirects to match renamed or deleted docs pages, this workflow takes the path to a gravitational/teleport clone. It finds mentions of Teleport docs site paths in each file changed by a PR and ensures that each path has a corresponding docs page or redirect source.

@ptgott
Copy link
Contributor Author

ptgott commented Nov 11, 2024

This PR is based on #289.

An example of a failed run is here: https://github.com/gravitational/teleport/actions/runs/11784998385/job/32825325002?pr=48761#step:7:8

@ptgott ptgott marked this pull request as ready for review November 12, 2024 13:49
@ptgott ptgott requested a review from a team as a code owner November 12, 2024 13:49
@ptgott ptgott force-pushed the paul.gottschling/2024-11-06-docs-redirs branch from d9e5a50 to de56c4f Compare November 19, 2024 21:09
@ptgott ptgott force-pushed the paul.gottschling/2024-11-06-docs-redirs branch from de56c4f to 5b46fbd Compare December 24, 2024 15:03
@ptgott ptgott force-pushed the paul.gottschling/2024-11-07-docs-link-check branch from c0bf70c to 1ddfa7d Compare December 24, 2024 15:28
@ptgott ptgott marked this pull request as draft December 24, 2024 15:48
@ptgott ptgott force-pushed the paul.gottschling/2024-11-07-docs-link-check branch from 1ddfa7d to 929c451 Compare December 24, 2024 16:41
@ptgott ptgott marked this pull request as ready for review December 24, 2024 16:41
@ptgott ptgott force-pushed the paul.gottschling/2024-11-06-docs-redirs branch from 5b46fbd to b96e8e0 Compare January 17, 2025 20:07
@ptgott ptgott force-pushed the paul.gottschling/2024-11-06-docs-redirs branch from b96e8e0 to aae6322 Compare January 31, 2025 20:35
@ptgott ptgott marked this pull request as draft February 4, 2025 16:03
@ptgott ptgott force-pushed the paul.gottschling/2024-11-07-docs-link-check branch from 929c451 to ae9715e Compare February 5, 2025 21:27
Like the workflow to check for necessary redirects to match renamed or
deleted docs pages, this workflow takes the path to a
`gravitational/teleport` clone. It finds mentions of Teleport docs site
paths in each file changed by a PR and ensures that each path has a
corresponding docs page or redirect source.
@ptgott ptgott force-pushed the paul.gottschling/2024-11-07-docs-link-check branch from ae9715e to 8033ad6 Compare February 5, 2025 22:05
@ptgott ptgott changed the base branch from paul.gottschling/2024-11-06-docs-redirs to main February 5, 2025 22:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant