Skip to content

Website Structure: Adopt Diataxis & Separate How to from Tutorial and Getting Started #859

@jakobmoellerdev

Description

@jakobmoellerdev

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

  1. Rename tutorials/? After extraction, only complex-component-structure-deployment.md remains. Merge elsewhere or rename to "Advanced Tutorials"?
  2. How-to weight: 45 (between Concepts and Tutorials) feels natural — or should it go after Tutorials?
  3. 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.
  4. 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

  • Code has been reviewed by other team members
  • Analysis of existing tests (Unit and Integration)
  • Unit Tests created for new code or existing Unit Tests updated
  • Integration Test Suite updated (includes deletion of existing unnecessary Integration Test and/or creation of new ones if required)
  • Enduser Documentation updated (if applicable)
  • Internal technical Documentation created/updated (if applicable)
  • Successful demonstration in Review

Metadata

Metadata

Labels

area/ipceiImportant Project of Common European Interestkind/tasksmall task, normally part of feature or epic

Type

No fields configured for Task.

Projects

Status
🍺 Done

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions