Skip to content

Commit

Permalink
[v16] Restructure docs menu pages (#48149)
Browse files Browse the repository at this point in the history
* Restructure docs menu pages

Backports #47797

Docusaurus [sidebar
generation](https://docusaurus.io/docs/next/sidebar/autogenerated)
expects category index pages to have one of three file path conventions:

- `section/index.mdx`
- `section/README.mdx`
- `section/section.mdx`

This change standardizes category index paths on the third convention so
Docusaurus sidebar generation succeeds. We can then add checks to the
current docs site to prevent additional menu pages from violating this
convention.

This change also adds redirects to the new category index pages, and
updates internal links to pages that were moved.

Note that this change does not move all relevant menu pages. We still
need to reorganize the `reference/terraform-provider` section. Since
this section is automatically generated, we need another approach to
restructuring it.

* Update Terraform reference category page locations

Backports #47955

As with #47797, Docusaurus expects category index pages to be
within--and named after--their parent directories. (Docusaurus also
accepts the names `README` and `index` for category pages, but we are
not using this convention.) This change applies this standard to our
Terraform provider reference docs.

- Update paths in the generator configuration. Assume that each category
  index page is in the same subdirectory as its contents.
- Update paths in the `lint.yaml` workflow.
- Fix internal links.
  • Loading branch information
ptgott authored Oct 30, 2024
1 parent 24fbee2 commit 32d9d8e
Show file tree
Hide file tree
Showing 195 changed files with 847 additions and 841 deletions.
30 changes: 15 additions & 15 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2637,7 +2637,7 @@ applications in Kubernetes clusters. When connected to a Kubernetes cluster (or
deployed as a Helm chart), the Teleport Discovery Service will automatically find
and enroll web applications with your Teleport cluster.

See documentation [here](docs/pages/enroll-resources/auto-discovery/kubernetes-applications.mdx).
See documentation [here](docs/pages/enroll-resources/auto-discovery/kubernetes-applications/kubernetes-applications.mdx).

#### Extended Kubernetes per-resource RBAC

Expand Down Expand Up @@ -4740,7 +4740,7 @@ is more than one major version behind them. You can use the `--skip-version-chec
bypass the version check.

Take a look at component compatibility guarantees in the
[documentation](docs/pages/upgrading.mdx).
[documentation](docs/pages/upgrading/upgrading.mdx).

#### HTTP_PROXY for reverse tunnels

Expand Down Expand Up @@ -5729,7 +5729,7 @@ if err = clt.CreateAccessRequest(ctx, accessRequest); err != nil {

### Upgrade Notes

Please follow our [standard upgrade procedure](docs/pages/admin-guides/management/admin.mdx) to upgrade your cluster.
Please follow our [standard upgrade procedure](docs/pages/admin-guides/management/admin/admin.mdx) to upgrade your cluster.

Note, for clusters using GitHub SSO and Trusted Clusters, when upgrading SSO users will lose connectivity to leaf clusters. Local users will not be affected.

Expand Down Expand Up @@ -5980,7 +5980,7 @@ Other updates:

* We now provide local user management via `https://[cluster-url]/web/users`, providing the ability to edit, reset and delete local users.
* Teleport Node & App Install scripts. This is currently an Enterprise-only feature that provides customers with an 'auto-magic' installer script. Enterprise customers can enable this feature by modifying the 'token' resource. See note above.
* We've added a Waiting Room for customers using Access Workflows. [Docs](docs/pages/admin-guides/access-controls/access-request-plugins.mdx)
* We've added a Waiting Room for customers using Access Workflows. [Docs](docs/pages/admin-guides/access-controls/access-request-plugins/access-request-plugins.mdx)

##### Signed RPM and Releases

Expand Down Expand Up @@ -6014,7 +6014,7 @@ We've added an [API Guide](docs/pages/admin-guides/api/api.mdx) to simply develo

#### Upgrade Notes

Please follow our [standard upgrade procedure](./docs/pages/upgrading.mdx).
Please follow our [standard upgrade procedure](docs/pages/upgrading/upgrading.mdx).

* Optional: Consider updating `https_key_file` & `https_cert_file` to our new `https_keypairs:` format.
* Optional: Consider migrating Kubernetes access from `proxy_service` to `kubernetes_service` after the upgrade.
Expand Down Expand Up @@ -6158,7 +6158,7 @@ auth_service:
### Upgrade Notes

Please follow our [standard upgrade
procedure](docs/pages/upgrading.mdx).
procedure](docs/pages/upgrading/upgrading.mdx).

## 4.3.9

Expand Down Expand Up @@ -6243,7 +6243,7 @@ Teleport's Web UI now exposes Teleport’s Audit log, letting auditors and admin

##### Teleport Plugins

Teleport 4.3 introduces four new plugins that work out of the box with [Approval Workflow](docs/pages/admin-guides/access-controls/access-request-plugins.mdx). These plugins allow you to automatically support role escalation with commonly used third party services. The built-in plugins are listed below.
Teleport 4.3 introduces four new plugins that work out of the box with [Approval Workflow](docs/pages/admin-guides/access-controls/access-request-plugins/access-request-plugins.mdx). These plugins allow you to automatically support role escalation with commonly used third party services. The built-in plugins are listed below.

* [PagerDuty](docs/pages/admin-guides/access-controls/access-request-plugins/ssh-approval-pagerduty.mdx)
* [Jira](docs/pages/admin-guides/access-controls/access-request-plugins/ssh-approval-jira.mdx)
Expand Down Expand Up @@ -6279,7 +6279,7 @@ Teleport 4.3 introduces four new plugins that work out of the box with [Approval
#### Upgrade Notes

Always follow the [recommended upgrade
procedure](./docs/pages/upgrading.mdx) to upgrade to this version.
procedure](docs/pages/upgrading/upgrading.mdx) to upgrade to this version.

##### New Signing Algorithm

Expand Down Expand Up @@ -6320,7 +6320,7 @@ permissions](./docs/pages/enroll-resources/kubernetes-access/controls.mdx).
The [etcd backend](docs/pages/reference/backends.mdx#etcd) now correctly uses
the “prefix” config value when storing data. Upgrading from 4.2 to 4.3 will
migrate the data as needed at startup. Make sure you follow our Teleport
[upgrade guidance](docs/pages/upgrading.mdx).
[upgrade guidance](docs/pages/upgrading/upgrading.mdx).

**Note: If you use an etcd backend with a non-default prefix and need to downgrade from 4.3 to 4.2, you should [backup Teleport data and restore it](docs/pages/admin-guides/management/operations/backup-restore.mdx) into the downgraded cluster.**

Expand Down Expand Up @@ -6443,7 +6443,7 @@ This is a minor Teleport release with a focus on new features and bug fixes.
### Improvements

* Alpha: Enhanced Session Recording lets you know what's really happening during a Teleport Session. [#2948](https://github.com/gravitational/teleport/issues/2948)
* Alpha: Workflows API lets admins escalate RBAC roles in response to user requests. [Read the docs](docs/pages/admin-guides/access-controls/access-requests.mdx). [#3006](https://github.com/gravitational/teleport/issues/3006)
* Alpha: Workflows API lets admins escalate RBAC roles in response to user requests. [Read the docs](docs/pages/admin-guides/access-controls/access-requests/access-requests.mdx). [#3006](https://github.com/gravitational/teleport/issues/3006)
* Beta: Teleport provides HA Support using Firestore and Google Cloud Storage using Google Cloud Platform. [Read the docs](docs/pages/admin-guides/deploy-a-cluster/deployments/gcp.mdx). [#2821](https://github.com/gravitational/teleport/pull/2821)
* Remote tctl execution is now possible. [Read the docs](./docs/pages/reference/cli/tctl.mdx). [#1525](https://github.com/gravitational/teleport/issues/1525) [#2991](https://github.com/gravitational/teleport/issues/2991)

Expand Down Expand Up @@ -6699,7 +6699,7 @@ The lists of improvements and bug fixes above mention only the significant chang

### Upgrading

Teleport 4.0 is backwards compatible with Teleport 3.2 and later. [Follow the recommended upgrade procedure to upgrade to this version.](docs/pages/upgrading.mdx)
Teleport 4.0 is backwards compatible with Teleport 3.2 and later. [Follow the recommended upgrade procedure to upgrade to this version.](docs/pages/upgrading/upgrading.mdx)

Note that due to substantial changes between Teleport 3.2 and 4.0, we recommend creating a backup of the backend datastore (DynamoDB, etcd, or dir) before upgrading a cluster to Teleport 4.0 to allow downgrades.

Expand Down Expand Up @@ -6967,7 +6967,7 @@ on Github for more.
#### Upgrading to 3.0

Follow the [recommended upgrade
procedure](docs/pages/upgrading.mdx) to upgrade to this
procedure](docs/pages/upgrading/upgrading.mdx) to upgrade to this
version.

**WARNING:** if you are using Teleport with the etcd back-end, make sure your
Expand Down Expand Up @@ -7073,7 +7073,7 @@ As always, this release contains several bug fixes. The full list can be seen [h
#### Upgrading

Follow the [recommended upgrade
procedure](docs/pages/upgrading.mdx) to upgrade to this
procedure](docs/pages/upgrading/upgrading.mdx) to upgrade to this
version.

## 2.6.9
Expand Down Expand Up @@ -7203,7 +7203,7 @@ You can see the full list of 2.6.0 changes [here](https://github.com/gravitation
#### Upgrading

Follow the [recommended upgrade
procedure](docs/pages/upgrading.mdx) to upgrade to this
procedure](docs/pages/upgrading/upgrading.mdx) to upgrade to this
version.

## 2.5.7
Expand Down Expand Up @@ -7290,7 +7290,7 @@ release, which includes:

* The Teleport daemon now implements built-in connection draining which allows
zero-downtime upgrades. [See
documentation](docs/pages/upgrading.mdx).
documentation](docs/pages/upgrading/upgrading.mdx).

* Dynamic join tokens for new nodes can now be explicitly set via `tctl node add --token`.
This allows Teleport admins to use an external mechanism for generating
Expand Down
Loading

0 comments on commit 32d9d8e

Please sign in to comment.