Skip to content

Commit

Permalink
Edit the docs release plan (#47814)
Browse files Browse the repository at this point in the history
Add an item to ensure that redirects only exist in the default version
of the docs. This is the version that we use to build the site map, and
links from the product and other Teleport sites only refer to
unversioned `/docs/` paths.
  • Loading branch information
ptgott authored Oct 23, 2024
1 parent 7a9f3de commit 67de9ce
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion .github/ISSUE_TEMPLATE/test-plan-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,15 @@ to determine the rollout date.
git submodule add https://github.com/gravitational/teleport content/<VERSION>.x
```

## Is the docs site up to date with the new release?
## Is the docs site content up to date with the new release?

- [ ] Verify that Teleport version variables are correct and reflect the upcoming
release. Check `docs/config.json` for this.

- [ ] Ensure that redirects (as configured in `docs/config.json`) only exist for
the default version of the docs site, and have been removed from other
versions.

- [ ] Remove version warnings in the docs that mention a version we no longer
support _except_ for the last EOL version. E.g., if we no longer support
version 10, remove messages saying "You need at least version n to use this
Expand Down

0 comments on commit 67de9ce

Please sign in to comment.