Add a workflow to enforce new docs redirects #289
+351
−26
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a
docpaths
workflow to the bot to ensure that any renamed or deleted docs pages accompany a new redirect in the docs config file (config.json
). This way, we can prevent docs changes from introducing 404s, whether because of delays in search engine indexing or broken links from Teleport-owned sites.The workflow takes a path to a
config.json
file, loads the redirect configuration, and checks whether all renamed and deleted pages correspond to a redirect. This change adds adocpaths
value of theworkflow
flag and an optionalteleport-path
flag for the path to agravitational/teleport
clone so the workflow can locate a docs configuration file.