mirror of
https://github.com/gravitational/teleport.git
synced 2026-10-12 02:15:01 +00:00
Paul Gottschling
b6d992c5ae
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 49 guides. Where an outcome statement is missing or incorrect, this change adds or corrects it. Changes include: - Landing pages: added `page_type: landing`, with no outcome statement required - Guides with entirely new outcome statements - Already-compliant guides: intro paragraphs already matched the required pattern, so this adds `page_type` only - Editing outcome statements to use compliant phrasing: a sentence in the introduction mostly matched the expected pattern, but required a small phrasing change