Skip to content

Commit

Permalink
Merge branch 'master' into rjones/client-tools
Browse files Browse the repository at this point in the history
  • Loading branch information
vapopov authored Jan 10, 2025
2 parents 83bdae2 + e10b956 commit d7afef7
Show file tree
Hide file tree
Showing 8,535 changed files with 887,152 additions and 471,332 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
7 changes: 0 additions & 7 deletions .eslintignore

This file was deleted.

2 changes: 0 additions & 2 deletions .eslintrc.js

This file was deleted.

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
/.github/workflows/ @klizhentas @russjones @r0mant @zmb3 @fheinecke @camscale @tcsc @rosstimothy @codingllama
/build.assets/tooling/cmd/difftest/ @klizhentas @russjones @r0mant @zmb3
126 changes: 73 additions & 53 deletions .github/ISSUE_TEMPLATE/test-plan-docs.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,52 @@
---
name: Documentation Test Plan
about: Manual test plan for Teleport major releases
name: Documentation Release Plan
about: Documentation checks and changes to perform for major Teleport releases
title: "Teleport X Docs Test Plan"
labels: testplan
---

Perform the following checks on the Teleport documentation whenever we release a
new major version of Teleport:
Perform the following tasks whenever we roll out a new major version of
Teleport.

## Is the docs site configuration accurate?
We need to make sure that the documentation site presents accurate information
to Teleport Enterprise (Cloud) users by default. Since we roll out a new major
Teleport version to Teleport Enterprise (Cloud) users several weeks after we
release the version, documentation release steps take place in two
phases:

- [ ] Verify the latest version in `gravitational/docs/config.json`
- **Phase One:** We have released a new major version of Teleport but have not
rolled it out to Teleport Enterprise (Cloud) customers.
- **Phase Two:** We have rolled out the new major version of Teleport to
Teleport Enterprise (Cloud) customers.

- [ ] Verify that `gravitational/docs/.gitmodules` contains the latest release
Use `/docs/upcoming-releases` to determine the Teleport Enterprise (Cloud)
rollout date.

- [ ] Ensure that submodule directories in `gravitational/docs` correspond to
those in `.gitmodules`.
## Phase One tasks

Remove the directory of the EOL release and create one for the next release
using a command similar to the following:
Make sure these tasks are complete by the time we have released a new major
version of Teleport.

```bash
git submodule add https://github.com/gravitational/teleport content/<VERSION>.x
```
- [ ] 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.

## Is the docs site up to date with the new release?
- [ ] Update the submodule configuration in `gravitational/docs-website`.

Remove the directory of the EOL release. Create a directory for the next
release using a command similar to the following:

```bash
git submodule add https://github.com/gravitational/teleport content/<VERSION>.x
```

Verify that `gravitational/docs-website/.gitmodules` contains the latest
release and not the EOL release.

- [ ] Verify that Teleport version variables are correct and reflect the upcoming
release. Check `docs/config.json` for this.
release. Check `docs/config.json` for this in all supported branches of
`gravitational/teleport`.

- [ ] 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
Expand All @@ -36,11 +55,11 @@ new major version of Teleport:

- [ ] Verify that all necessary documentation for the release was backported to
the release branch:
- [ ] Diff between master and release branch and make sure there are no missed
PRs
- [ ] Diff between `master` and the new release branch and make sure there are
no missed PRs.
- [ ] Ensure that the release branch's documentation content reflects all
changes introduced by the release. If not, plan to update the docs ASAP and
notify all relevant teams of the delay (e.g., Developer Relations).
notify all relevant teams of the delay.

- [ ] Verify that the [changelog](../../CHANGELOG.md) is up to date and complete
for the default docs version. If one release branch has a more complete
Expand All @@ -51,46 +70,47 @@ new major version of Teleport:
$ git checkout origin/branch/v<release_version> -- CHANGELOG.md
```

- [ ] Verify the supported versions table in the FAQ
(https://goteleport.com/docs/faq/#supported-versions)
- [ ] Verify that the [Upcoming Releases
Page](../../docs/pages/upcoming-releases.mdx) only exists for the major
version of Teleport we are releasing. Ensure that this page contains the
latest information:
- [ ] Update the supported versions table in the FAQ
(https://goteleport.com/docs/faq/#supported-versions).

```bash
$ git checkout origin/branch/v<last_version> -- docs/pages/upcoming-releases.mdx
```
- [ ] Verify the accuracy of critical docs pages. Follow the docs guides below
and verify their accuracy while using the newly released major version of
Teleport.

## Verify the accuracy of critical docs pages
- [ ] General [installation page](../../docs/pages/installation.mdx): ensure
that installation methods support the new release candidate.
- [ ] [Teleport Community
Edition](../../docs/pages/admin-guides/deploy-a-cluster/linux-demo.mdx) demo
guide.
- [ ] [Teleport Enterprise (Cloud)](../../docs/pages/get-started.mdx) getting
started guide.
- [ ] [Teleport Enterprise (Self-Hosted) with
Helm](../../docs/pages/admin-guides/deploy-a-cluster/helm-deployments/kubernetes-cluster.mdx)
- [ ] [Teleport Enterprise (Self-Hosted) with
Terraform](../../docs/pages/admin-guides/deploy-a-cluster/deployments/aws-ha-autoscale-cluster-terraform.mdx)

Follow the docs guides below and verify their accuracy. To do so, open the
version of the docs site that corresponds to the major release we're testing
for. For example, for Teleport 12 release use `branch/v12` branch and make sure
to select "Version 12.0" in the documentation version switcher.
## Phase Two changes

### Installation
Make sure these tasks are complete by the time we have rolled out a new major
version of Teleport to Teleport Enterprise (Cloud) customers.

- [ ] General [installation page](../../docs/pages/installation.mdx): ensure that
installation methods support the new release candidate.
- [ ] Enterprise Cloud [downloads
page](../../docs/pages/choose-an-edition/teleport-cloud/downloads.mdx): ensure that
the release cnadidate is available at the repositories we link to.
- [ ] Update the docs site configuration in
`gravitational/docs-website/config.json`: ensure that the EOL version has
`"deprecated": true` assigned and the newly rolled out version has
`"isDefault" true`. Remove the `"isDefault": true` assignment from the
previous version.

### Getting started
- [ ] Copy the changelog from the previous default branch to the new one:

- [ ] [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 with
Terraform](../../docs/pages/deploy-a-cluster/deployments/aws-ha-autoscale-cluster-terraform.mdx)
```bash
$ git checkout origin/branch/v<release_version> -- CHANGELOG.md
```

### New feature docs
- [ ] Verify that the [Upcoming Releases
Page](../../docs/pages/upcoming-releases.mdx) only exists for the major
version of Teleport we have rolled out. Ensure that this page contains the
latest information:

- [ ] 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.
```bash
$ git checkout origin/branch/v<last_version> -- docs/pages/upcoming-releases.mdx
```
Loading

0 comments on commit d7afef7

Please sign in to comment.