-
Notifications
You must be signed in to change notification settings - Fork 3
Component Authoring Documentation #889
Copy link
Copy link
Closed
open-component-model/ocm-website
#739Labels
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
Rework component authoring. Constructor explained in getting-started but needs dedicated how-to. Product modeling patterns only available in /docs/tutorials/structure-software-products-with-ocm. Needs own How-to.
Tasks:
Reference page (json schema) for the constructor because it has a good schema, and then a how-to describing how using it.
content/docs/how-to/use-component-constructor.md(NEWhow-totutorial) - Constructor patterns, resource definitions, composition using referencescontent/docs/how-to/model-products.md(NEW how-to) - Multi-component modeling, references, versioningcontent/docs/getting-started/create-component-version.md(REWORK getting started) - Keep quick-start, link to constructor how-to for advanced usage -> feat: reworked add cv ocm-website#703content/docs/tutorials/component-descriptor-example.md(REVIEW tutorial) - It is not a real tutorial, but just stored under "tutorial". Content needs to go into another tutorial or the newcontent/docs/how-to/use-component-constructor.mdcontent/docs/reference/component-descriptor.mdcontent/docs/reference/component-construtor.mdDone Criteria