Description
CONTRIBUTING.md defines a Diataxis-based content structure that includes a how-to/ section — but it doesn't exist yet. Content that qualifies as "How-to Guides" (task-oriented, goal-focused, assumes competence) is currently scattered across tutorials/ and getting-started/.
Problems:
- Newcomers hit task-oriented pages that assume prior knowledge
- Experienced users find reference material mixed into guided tutorials
- No clear home for new task-oriented contributions
Current state: getting-started/ (7 pages) · tutorials/ (7 pages) · how-to/ (does not exist)
Proposed Classification
getting-started/ → keep as Tutorials
Sequential newcomer learning path — no changes. Controllers should eventually get their own learning path separate from the CLI.
tutorials/ → split across sections
| Page |
Action |
complex-component-structure-deployment.md |
Stay (separate out) |
signing-and-verification.md |
→ how-to/ (reshape) |
credentials.md |
→ how-to/ (add concrete controller guidance) |
creds-in-ocmconfig.md |
→ how-to/ (make registry-specific) |
component-descriptor-example.md |
→ concepts/ |
input-and-access-types.md |
→ concepts/ |
Proposed sidebar order
| Section |
Weight |
Diataxis type |
| Overview |
10 |
Explanation |
| Getting Started |
20 |
Tutorial (newcomer) |
| Concepts |
40 |
Explanation |
| How-to Guides |
45 |
How-to (NEW) |
| Tutorials |
50 |
Tutorial (advanced) |
| Reference |
60 |
Reference |
Open Questions
- Rename
tutorials/? After extraction, only complex-component-structure-deployment.md remains. Merge elsewhere or rename to "Advanced Tutorials"?
- How-to weight: 45 (between Concepts and Tutorials) feels natural — or should it go after Tutorials?
- Consolidate credential pages?
credentials.md and creds-in-ocmconfig.md overlap. Merge into a single how-to guide?ment.md remains. Consider whether this section should be renamed to "Advanced Tutorials" or merged elsewhere.
- Weight for how-to section: CONTRIBUTING.md doesn't specify a weight. Placing it between Concepts (40) and Tutorials (50) at 45 seems natural, but an alternative is placing it after Tutorials.
Done Criteria
Description
CONTRIBUTING.mddefines a Diataxis-based content structure that includes ahow-to/section — but it doesn't exist yet. Content that qualifies as "How-to Guides" (task-oriented, goal-focused, assumes competence) is currently scattered acrosstutorials/andgetting-started/.Problems:
Current state:
getting-started/(7 pages) ·tutorials/(7 pages) ·how-to/(does not exist)Proposed Classification
getting-started/→ keep as TutorialsSequential newcomer learning path — no changes. Controllers should eventually get their own learning path separate from the CLI.
tutorials/→ split across sectionscomplex-component-structure-deployment.mdsigning-and-verification.mdhow-to/(reshape)credentials.mdhow-to/(add concrete controller guidance)creds-in-ocmconfig.mdhow-to/(make registry-specific)component-descriptor-example.mdconcepts/input-and-access-types.mdconcepts/Proposed sidebar order
Open Questions
tutorials/? After extraction, onlycomplex-component-structure-deployment.mdremains. Merge elsewhere or rename to "Advanced Tutorials"?credentials.mdandcreds-in-ocmconfig.mdoverlap. Merge into a single how-to guide?ment.md remains. Consider whether this section should be renamed to "Advanced Tutorials" or merged elsewhere.Done Criteria