mirror of
https://github.com/gravitational/teleport.git
synced 2026-09-17 17:40:30 +08:00
Paul Gottschling
007a9be195
Continues the work from the previous batch (#67674). 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 assigns the `page_type` frontmatter field to 46 guides. Where an outcome statement is missing, it adds one. Where an outcome statement exists, it ensures that the statement matches the standard structure so we can add a linter later on. Of the 46 guides: - 12 guides already included the expected outcome statement, but needed a `page_type` frontmatter field. - 19 guides included an outcome statement but required minor tweaks so they followed the expected structure. - 15 guides had no outcome statement at all.