mirror of
https://github.com/gravitational/teleport.git
synced 2026-09-19 11:00:37 +08:00
Paul Gottschling
36fc5226f2
We are standardizing docs guides to add a page_type frontmatter field, with values for how-to guides, references, etc. We can then use this field to apply linting rules that ensure each guide type follows type-specific docs site conventions. The first convention is that each docs page must have an outcome statement, the structure of which depends on the guide's type. Human and AI agent readers can determine from the outcome statement whether to continue reading the guide or not. This change applies a `page_type` frontmatter field to 46 guides in the `enroll-resources` section of the docs. Most of these guides already include the expected outcome statement. For those that do not, this change adds one: - Automatic user provisioning introduction partial - Host user creation - Encrypted session recording guide - ClickHouse guide (rewording the existing outcome statement to match the standard structure we are rolling out). - Automatic session recording key rotation - Manual session recording key rotation - macOS launchd guide
Teleport Docs
Teleport docs are built using Docusaurus. Please see the README in the docs-website repo for details on how to make and test changes to Teleport docs.