-
Notifications
You must be signed in to change notification settings - Fork 3
Core Model & Identity Documentation #885
Copy link
Copy link
Closed
open-component-model/ocm-website
#771Labels
area/documentationDocumentation relatedDocumentation relatedarea/ipceiImportant Project of Common European InterestImportant Project of Common European Interestkind/tasksmall task, normally part of feature or epicsmall task, normally part of feature or epic
Metadata
Metadata
Assignees
Labels
area/documentationDocumentation relatedDocumentation relatedarea/ipceiImportant Project of Common European InterestImportant Project of Common European Interestkind/tasksmall task, normally part of feature or epicsmall task, normally part of feature or epic
Type
Fields
Give feedbackNo fields configured for issues without a type.
Projects
StatusShow more project fields
🔍 Review
Description
Create a general intro to OCM in
Overviewsection explaining OCM's core model at high level. Then create a comprehensiveConceptsdoc merging existing Components + Coordinates docs and adding the Component constructor.Current state:
overview/has benefits + project but no core model introconcepts/components.md+concepts/coordinates.mdseparateTarget:
Tasks:
content/docs/overview/core-model.md(NEW or adjusted) - High-level intro: what is component identity, why it matters, basic mental model (unify with how ocm works)content/docs/concepts/component-identity.md(NEW) - Merge components.md + coordinates.md; add component descriptor structure, constructor, CTF formatcontent/docs/concepts/components.md(DELETE) - Content movedcontent/docs/concepts/coordinates.md(DELETE) - Content movedcontent/docs/getting-started/create-component-version.md(REWORK) - Link to new docs we already havecontent/docs/tutorials/component-descriptor-example.md(REVIEW) - Cross-link to concept doc (we should already have that)Done Criteria