Skip to content

Commit

Permalink
field-not-required
Browse files Browse the repository at this point in the history
  • Loading branch information
zmb3 committed Dec 4, 2024
1 parent a9c7978 commit 6602d2a
Show file tree
Hide file tree
Showing 5,116 changed files with 336,363 additions and 382,423 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Merge rules are governed by logic in the Workflow Bot. Protect the
# .github/workflows directory (and the merge logic) using CODEOWNERS.
/.github/workflows/ @klizhentas @russjones @r0mant @zmb3 @fheinecke @camscale @tcsc @rosstimothy @codingllama
/.github/workflows/ @klizhentas @russjones @r0mant @zmb3 @fheinecke @camscale @tcsc
/build.assets/tooling/cmd/difftest/ @klizhentas @russjones @r0mant @zmb3
38 changes: 15 additions & 23 deletions .github/ISSUE_TEMPLATE/test-plan-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,11 @@ title: "Teleport X Docs Test Plan"
labels: testplan
---

Perform the following checks on the Teleport documentation whenever we roll out
a new major version of Teleport on Teleport Cloud. Use `/docs/upcoming-releases`
to determine the rollout date.

## Is the internal documentation coverage record up to date?

- [ ] Identify features within the new release that we want to include as topics
in our measurement of documentation coverage. Update our internal
documentation coverage record to include the new topics. See our internal
knowledge base for the location of the coverage record.
Perform the following checks on the Teleport documentation whenever we release a
new major version of Teleport:

## Is the docs site configuration accurate?

> [!IMPORTANT]
> **Do not merge the new docs site configuration** before we roll out a new
> major version to Teleport Enterprise (Cloud).
- [ ] Verify the latest version in `gravitational/docs/config.json`

- [ ] Verify that `gravitational/docs/.gitmodules` contains the latest release
Expand All @@ -36,15 +24,11 @@ to determine the rollout date.
git submodule add https://github.com/gravitational/teleport content/<VERSION>.x
```

## Is the docs site content up to date with the new release?
## Is the docs site 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 Expand Up @@ -96,9 +80,17 @@ to select "Version 12.0" in the documentation version switcher.
### Getting started
- [ ] [Teleport Community Edition](../../docs/pages/index.mdx)
- [ ] [Teleport Enterprise (Cloud)](../../docs/pages/choose-an-edition/teleport-cloud/get-started.mdx).
- [ ] [Teleport Enterprise (Self-Hosted) with
- [ ] [Community Edition](../../docs/pages/index.mdx)
- [ ] [Teleport Team](../../docs/pages/choose-an-edition/teleport-team.mdx)
(this also serves as the getting started guide for Teleport Enterprise Cloud).
- [ ] [Teleport Enterprise with
Helm](../../docs/pages/deploy-a-cluster/helm-deployments/kubernetes-cluster.mdx)
- [ ] [Teleport Enterprise (Self-Hosted) with
- [ ] [Teleport Enterprise with
Terraform](../../docs/pages/deploy-a-cluster/deployments/aws-ha-autoscale-cluster-terraform.mdx)
### New feature docs
- [ ] Review the roadmap for the major version we are releasing and verify that
you can complete all how-to guides for new features successfully. Consult the
[Upcoming Releases Page](../../docs/pages/upcoming-releases.mdx) for a list of
features in the next major release.
424 changes: 143 additions & 281 deletions .github/ISSUE_TEMPLATE/testplan.md

Large diffs are not rendered by default.

Loading

0 comments on commit 6602d2a

Please sign in to comment.