Skip to content

Commit ac9be7d

Browse files
committed
update templates and add template for concepts
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
1 parent d83824c commit ac9be7d

File tree

3 files changed

+88
-175
lines changed

3 files changed

+88
-175
lines changed

content_templates/template-concept.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@ Write 2–4 sentences answering: *What is this? What problem does it solve? Wher
1212

1313
Avoid "how to configure" or step-by-step instructions here. This section builds the mental model.
1414

15-
> **Example:** A resolver maps component name patterns to OCM repositories. When OCM encounters a component reference during recursive resolution, it consults the configured resolvers to locate the right repository — without requiring the caller to know where each component lives.
15+
> **Example:** A resolver maps component name patterns to OCM repositories.
16+
> When OCM encounters a component reference during recursive resolution,
17+
> it consults the configured resolvers to locate the right repository — without
18+
> requiring the caller to know where each component lives.
1619
1720
## Why does it exist?
1821

@@ -81,20 +84,23 @@ If this concept has common misconceptions, address them here briefly.
8184

8285
## Next steps
8386

84-
- [How-to: <name>]({{< relref "docs/how-to/<file>.md" >}})
87+
Add links to related guides where you DO or LEARN more about the topic.
88+
89+
- [How-To: <name>]({{< relref "docs/how-to/<file>.md" >}})
90+
- [Tutorial: <name>]({{< relref "docs/tutorials/<file>.md" >}})
8591

8692
## Related documentation
8793

94+
Add links to related concepts and references that explain the WHY and provide more details.
95+
8896
- [Concept: <name>]({{< relref "docs/concepts/<file>.md" >}})
89-
- [Tutorial: <name>]({{< relref "docs/tutorials/<file>.md" >}})
9097
- [Reference: <command>]({{< relref "docs/reference/<file>.md" >}})
9198

9299
---
93100

94101
## ✓ Before publishing
95102

96-
Make sure to comply with our [CONTRIBUTING guide](../CONTRIBUTING.md),
97-
check the [Concept Writing Checklist](../CONTRIBUTING.md#concept-checklist),
103+
Make sure to comply with our [CONTRIBUTING guide](../CONTRIBUTING.md)
98104
and ensure the following:
99105

100106
- [ ] Title is a noun or noun phrase — not a verb or task (e.g., "Resolvers", not "How to use resolvers")
@@ -105,5 +111,4 @@ and ensure the following:
105111
- [ ] Subsections address distinct orthogonal aspects
106112
- [ ] "Relationship to other concepts" section with relref links
107113
- [ ] "When to use it" section helps readers self-identify relevance
108-
- [ ] No CLI commands that constitute a workflow (short illustrative snippets are OK)
109114
- [ ] Working `relref` links throughout

content_templates/template-how-to.md

Lines changed: 51 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,6 @@ Include a diagram only if it clarifies the process. Keep it simple (3–5 nodes
2323
```mermaid
2424
flowchart LR
2525
A[Input] --> B[ocm command] --> C[Output]
26-
27-
style A fill:#e1f5ff,color:#000
28-
style B fill:#fff4e6,color:#000
29-
style C fill:#e8f5e9,color:#000
3026
```
3127

3228
One sentence explaining what this diagram shows.
@@ -45,68 +41,67 @@ See [Diagram Color Guide]({{< relref "content_templates/template-tutorial.md#dia
4541

4642
## Steps
4743

48-
1. **Do the first thing**
44+
### Do the first thing
4945

50-
Brief explanation (1–2 sentences max). Link to concepts for "why"—don't explain inline.
46+
Brief explanation (1–2 sentences max). Link to concepts for "why"—don't explain inline.
5147

52-
```bash
53-
ocm <command> <args>
54-
```
48+
```bash
49+
ocm <command> <args>
50+
```
5551

56-
{{< callout type="tip" >}}
57-
**Handling variants:** If your how-to covers multiple approaches or platforms, use tabs to show alternatives:
52+
{{< callout type="tip" >}}
53+
**Handling variants:** If your how-to covers multiple approaches or platforms, use tabs to show alternatives:
54+
{{< /callout >}}
5855

59-
{{< tabs "signing-methods" >}}
60-
{{< tab "RSA Key" >}}
61-
```bash
62-
ocm sign cv --private-key private.key
63-
```
64-
{{< /tab >}}
65-
{{< tab "Sigstore" >}}
66-
```bash
67-
ocm sign cv --sigstore
68-
```
69-
{{< /tab >}}
70-
{{< /tabs >}}
71-
{{< /callout >}}
56+
{{< tabs "signing-methods" >}}
57+
{{< tab "RSA Key" >}}
58+
```bash
59+
ocm sign cv --private-key private.key
60+
```
61+
{{< /tab >}}
62+
{{< tab "Sigstore" >}}
63+
```bash
64+
ocm sign cv --sigstore
65+
```
66+
{{< /tab >}}
67+
{{< /tabs >}}
7268

73-
You should see: `[specific success indicator]`.
69+
You should see: `[specific success indicator]`.
7470

75-
<details>
76-
<summary>Output</summary>
71+
Hide complex output behind a details block:
72+
{{< details "Expected output">}}
7773

78-
```text
79-
...
80-
```
81-
</details>
74+
```text
75+
...
76+
```
77+
{{< /details >}}
8278

83-
2. **Do the next thing**
79+
### Do the next thing
8480

85-
If needed, show the minimal config:
81+
If needed, show the minimal config:
8682

87-
```yaml
88-
# Key fields only
89-
key: value
90-
required: field
91-
```
83+
```yaml
84+
# Key fields only
85+
key: value
86+
required: field
87+
```
9288
93-
3. **Verify**
89+
### Do the last thing
9490
95-
Show the shortest check that proves success:
91+
Show the shortest check that proves success:
9692
97-
```bash
98-
ocm <command> --check
99-
```
93+
```bash
94+
ocm <command> --check
95+
```
10096

101-
You should see: `[expected output]`. This confirms your setup is correct.
97+
You should see: `[expected output]`. This confirms your setup is correct.
10298

103-
<details>
104-
<summary>Expected output</summary>
99+
{{< details "Expected output">}}
105100

106-
```text
107-
OK ...
108-
```
109-
</details>
101+
```text
102+
OK ...
103+
```
104+
{{< /details >}}
110105

111106
## Troubleshooting
112107

@@ -127,14 +122,6 @@ See [Diagram Color Guide]({{< relref "content_templates/template-tutorial.md#dia
127122

128123
**Fix:** ...
129124

130-
### Getting help
131-
132-
If these solutions don't work:
133-
134-
- [OCM Troubleshooting Guide]({{< relref "docs/troubleshooting/_index.md" >}})
135-
- [Community Support](link)
136-
- [Open an Issue](https://github.com/open-component-model/ocm/issues)
137-
138125
## Cleanup (optional)
139126

140127
Remove resources created:
@@ -150,20 +137,22 @@ Remove resources created:
150137

151138
## Next steps
152139

153-
- [How-to: <name>]({{< relref "docs/how-to/<file>.md" >}})
140+
Add links to related guides where you DO or LEARN more about the topic.
141+
142+
- [Tutorial: <name>]({{< relref "docs/tutorials/<file>.md" >}})
154143

155144
## Related documentation
156145

146+
Add links to related concepts and references that explain the WHY and provide more details.
147+
157148
- [Concept: <name>]({{< relref "docs/concepts/<file>.md" >}})
158-
- [Tutorial: <name>]({{< relref "docs/tutorials/<file>.md" >}})
159149
- [Reference: <command>]({{< relref "docs/reference/<file>.md" >}})
160150

161151
---
162152

163153
## ✓ Before publishing
164154

165-
Make sure to comply to our [CONTRIBUTING guide](../CONTRIBUTING.md),
166-
check the [Tutorial Writing Checklist](../CONTRIBUTING.md#how-to-guide-checklist),
155+
Make sure to comply to our [CONTRIBUTING guide](../CONTRIBUTING.md)
167156
and ensure the following:
168157

169158
- [ ] Title starts with "How to..." or action verb (Configure/Deploy/Create/...)

0 commit comments

Comments
 (0)