Commit 0c33f41
committed
docs: add component authoring documentation
<!-- markdownlint-disable MD041 -->
Adds comprehensive documentation for component authoring with the new OCM CLI:
**New reference pages:**
- `reference/component-constructor.md` — field reference for `component-constructor.yaml`, the input format for `ocm add cv`
- `reference/component-descriptor.md` — field reference for the component descriptor output format (v2 schema)
- `reference/input-and-access-types.md` — field-level reference for all supported input types (`dir`, `file`, `helm/v1`, `utf8`) and access types (`OCIImage`, `localBlob`, `OCIImageLayer`, `Helm`)
**New how-to and tutorial:**
- `how-to/model-products.md` — step-by-step guide for modeling multi-component products with component references
- `tutorials/advanced-component-constructor.md` — tutorial covering multi-component constructors, labels, sources, and nesting patterns
**Replaced outdated content:**
- Removed `tutorials/complex-component-structure-deployment.md` (replaced by `model-products.md`)
- Removed `tutorials/component-descriptor-example.md` (replaced by `component-descriptor.md` reference)
- Moved and rewrote `tutorials/input-and-access-types.md` as a reference page, removing types not supported by the new OCM (`binary`, `docker`, `dockermulti`, `ociImage`, `spiff`, `gitHub`, `npm`, `s3`, `wget`)
<!--
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
-->
Fixes: open-component-model/ocm-project#889
Signed-off-by: Piotr Janik <piotr.janik@sap.com>1 parent 9637427 commit 0c33f41
File tree
6 files changed
+15
-14
lines changed- content/docs
- getting-started
- how-to
- reference
- tutorials
6 files changed
+15
-14
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
480 | 480 | | |
481 | 481 | | |
482 | 482 | | |
483 | | - | |
| 483 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | | - | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
14 | 17 | | |
15 | 18 | | |
16 | | - | |
| 19 | + | |
17 | 20 | | |
| 21 | + | |
18 | 22 | | |
19 | | - | |
20 | | - | |
21 | | - | |
| 23 | + | |
22 | 24 | | |
23 | 25 | | |
24 | 26 | | |
| |||
36 | 38 | | |
37 | 39 | | |
38 | 40 | | |
39 | | - | |
| 41 | + | |
40 | 42 | | |
41 | 43 | | |
42 | 44 | | |
| |||
134 | 136 | | |
135 | 137 | | |
136 | 138 | | |
137 | | - | |
138 | | - | |
139 | 139 | | |
140 | 140 | | |
141 | 141 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | | - | |
| 11 | + | |
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
| |||
107 | 107 | | |
108 | 108 | | |
109 | 109 | | |
110 | | - | |
| 110 | + | |
111 | 111 | | |
112 | 112 | | |
113 | 113 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
| 30 | + | |
30 | 31 | | |
31 | 32 | | |
32 | 33 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
332 | 332 | | |
333 | 333 | | |
334 | 334 | | |
335 | | - | |
| 335 | + | |
336 | 336 | | |
337 | 337 | | |
338 | 338 | | |
0 commit comments