Skip to content

Commit 72800c3

Browse files
template addition
1 parent 56c0a2d commit 72800c3

5 files changed

Lines changed: 143 additions & 72 deletions

File tree

modules/ROOT/pages/3rd-party-script.adoc

Lines changed: 0 additions & 72 deletions
This file was deleted.

modules/_templates/concept.adoc

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
= <Title: Noun phrase describing the concept>
2+
:toc: true
3+
:toclevels: 1
4+
:page-pageid:
5+
:page-type: concept
6+
:page-role:
7+
:product-version: <version>
8+
:jira-ref: <DOC-XXXX>
9+
// author:
10+
// last-reviewed:
11+
12+
// 1-2 sentence lead: what this concept is and why it matters.
13+
14+
== How <concept> works
15+
16+
// Explanation. Use diagrams (image::) where spatial relationships matter.
17+
// Avoid procedure steps here — link to procedure pages instead.
18+
19+
== Key components
20+
21+
// Optional. Use a definition list for named parts:
22+
Component name::
23+
Description of what it does.
24+
25+
== Limitations and constraints
26+
27+
// Known limitations, version-specific behaviour, or edge cases.
28+
// TODO: verify with engineering
29+
30+
== Related information
31+
32+
* xref:<component>:<module>/page.adoc[Link text]

modules/_templates/procedure.adoc

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
= <Title: Verb + Object, e.g. "Configure Single Sign-On">
2+
:toc: true
3+
:toclevels: 1
4+
:page-pageid:
5+
:page-type: procedure
6+
:page-role:
7+
:product-version: <version>
8+
:jira-ref: <DOC-XXXX>
9+
// author:
10+
// last-reviewed:
11+
12+
== Overview
13+
14+
// 1-2 sentences: what this procedure accomplishes and who it is for.
15+
// TODO: verify with engineering
16+
17+
== Before you begin
18+
19+
// Prerequisites as a list. Use "You must" or "You need" for each.
20+
*
21+
*
22+
23+
== Procedure
24+
25+
. Step one. Include the exact command or UI action.
26+
+
27+
[source,bash]
28+
----
29+
# example command here
30+
----
31+
32+
. Step two.
33+
34+
. Step three.
35+
36+
== Result
37+
38+
// What the user should see or be able to do after completing the procedure.
39+
40+
== Next steps
41+
42+
// Optional. Link to related procedures or concepts.
43+
44+
== Related information
45+
46+
* xref:<component>:<module>/page.adoc[Link text]

modules/_templates/reference.adoc

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
= <Title: Noun phrase, e.g. "API Endpoint Reference">
2+
:toc: true
3+
:toclevels: 1
4+
:page-pageid:
5+
:page-type: reference
6+
:page-role:
7+
:product-version: <version>
8+
:jira-ref: <DOC-XXXX>
9+
// author:
10+
// last-reviewed:
11+
12+
// Brief description of what this reference covers.
13+
14+
[cols="1,1,1,3", options="header"]
15+
|===
16+
|Parameter |Type |Required |Description
17+
18+
|`param_name`
19+
|string
20+
|Yes
21+
|Description of what this parameter does. Default: none.
22+
23+
|===
24+
25+
== Example
26+
27+
[source,json]
28+
----
29+
{
30+
"param_name": "value"
31+
}
32+
----
33+
34+
== Related information
35+
36+
* xref:<component>:<module>/page.adoc[Link text]
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
= Release Notes: <Product> <Version>
2+
:page-type: release-note
3+
:page-role:
4+
:product-version: <version>
5+
:jira-ref: <DOC-XXXX>
6+
7+
== New features
8+
9+
=== <Feature name>
10+
11+
// One sentence describing what it does and who benefits.
12+
// TODO: link to full feature documentation once published.
13+
14+
== Improvements
15+
16+
* Brief description. (<JIRA-REF>)
17+
18+
== Bug fixes
19+
20+
* Brief description of what was broken and what was fixed. (<JIRA-REF>)
21+
22+
== Known issues
23+
24+
* Description of the issue and any workaround.
25+
26+
== Upgrade notes
27+
28+
// Required only if this version includes breaking changes or migration steps.
29+
// TODO: verify with engineering

0 commit comments

Comments
 (0)