Skip to content

Component Authoring Documentation #889

@morri-son

Description

@morri-son

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.

  • getting started -> ( will most likely be a very well used page because it's one of the most important things to do first ) ( link to the reference, and a new how to ) ( it's part of the ocm CLI so make sure it's cleanly separated )
  • content/docs/how-to/use-component-constructor.md (NEW how-to tutorial) - Constructor patterns, resource definitions, composition using references
  • content/docs/how-to/model-products.md (NEW how-to) - Multi-component modeling, references, versioning
  • content/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#703
  • content/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 new content/docs/how-to/use-component-constructor.md
  • content/docs/reference/component-descriptor.md
  • content/docs/reference/component-construtor.md

Done Criteria

  • Constructor how-to
  • Product modeling how-to
  • Getting-started links to how-to for details
  • No duplicate content
  • All relrefs updated

Metadata

Metadata

Assignees

Labels

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

Type

No type
No fields configured for issues without a type.

Projects

Status
🔍 Review

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions