33This guide helps contributors create and place new documentation content according to the [ Diataxis framework] ( https://diataxis.fr/ ) .
44These guidelines apply to ** all new content** and do not reorganize existing documentation.
55
6+ _ NOTE: You may notice some inconsistencies with our current structure. You are encouraged to contribute improvements to this guide and
7+ to the existing documentation to make it conform to this guideline._
8+
69## Table of Contents
710
811- [ Diataxis Overview] ( #diataxis-overview )
@@ -45,12 +48,14 @@ Each type serves a distinct purpose. Mixing types within a single document confu
4548Explain the "why" behind OCM design decisions.
4649
4750** Characteristics:**
51+
4852- Provide context, rationale, and connections
4953- Can include opinions and trade-off discussions
5054- No step-by-step instructions
5155- Link to OCM Specification for authoritative definitions
5256
5357** Example titles:**
58+
5459- "Understanding Component Versions"
5560- "The OCM Security Model"
5661
@@ -61,25 +66,29 @@ Explain the "why" behind OCM design decisions.
6166Guide newcomers through complete learning experiences.
6267
6368** Characteristics:**
69+
6470- Every step produces a visible, verifiable result
6571- Show destination upfront ("In this tutorial you will...")
6672- Avoid explanation digressions - link to Concepts or how to instead
6773- Perfect reliability: every command must work exactly as written
6874
6975** Example titles:**
76+
7077- "Create Your First Component Version"
7178
7279#### Other Tutorials (` tutorials/ ` )
7380
7481Goal-oriented directions for specific tasks.
7582
7683** Characteristics:**
84+
7785- Assume reader knows OCM basics (completed Getting Started), reference as needed
7886- Use conditional structure: "If you want X, do Y"
7987- One focused task per guide
8088- Link to Reference for parameter details
8189
8290** Example titles:**
91+
8392- "(How to) Configure Private Registry Authentication"
8493- "(How to) Transfer Components Between Registries"
8594
@@ -88,11 +97,13 @@ Goal-oriented directions for specific tasks.
8897Factual, authoritative technical descriptions.
8998
9099** Characteristics:**
100+
91101- Structure mirrors the product (CLI commands, CRD fields, etc.)
92102- Include usage examples, not tutorials
93103- Auto-generated from source repos where possible
94104
95105** Example content:**
106+
96107- CLI command reference (imported via Hugo module)
97108- Configuration schema documentation
98109- CRD field specifications
@@ -103,7 +114,7 @@ Factual, authoritative technical descriptions.
103114
104115Use this flowchart to determine where new content belongs when contributing to the website:
105116
106- ```
117+ ``` text
107118New documentation content?
108119 |
109120 v
@@ -151,7 +162,7 @@ Documentation lives in different repositories depending on what it documents.
151162
152163### Feature-Based Decision Tree
153164
154- ```
165+ ``` text
155166What are you documenting?
156167
157168CLI command/flag in old CLI (open-component-model/ocm)?
0 commit comments