You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contributing_to_docs/doc_guidelines.adoc
+7-13Lines changed: 7 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,12 +39,10 @@ Every assembly file must contain the following metadata at the top, with no blan
39
39
:_mod-docs-content-type: ASSEMBLY <1>
40
40
[id="<assembly-anchor-id>"] <2>
41
41
= Assembly title <3>
42
-
<4>
43
-
include::_attributes/common-attributes.adoc[] <5>
42
+
include::_attributes/common-attributes.adoc[] <4>
43
+
:context: <assembly-context> <5>
44
44
<6>
45
-
:context: <assembly-context> <7>
46
-
<8>
47
-
toc::[] <9>
45
+
toc::[] <7>
48
46
----
49
47
<1> The content type for the file. For assemblies, always use `:_mod-docs-content-type: ASSEMBLY`. Place this attribute before the anchor ID or, if present, the conditional that contains the anchor ID.
50
48
<2> A unique (within OpenShift docs) anchor ID for this assembly. Use lowercase and hyphens, for example: `cli-developer-commands`.
@@ -58,8 +56,7 @@ toc::[] <9>
58
56
* The assembly title, which is the first line of the document, is the only level 1 ( `=` ) title.
59
57
Section headers within the assembly must be H2 ("Level 1" in AsciiDoc terminology), formatted as `==`. When you include modules, you must add leveloffsets in the include statements. You can manually add more H2 (`==`) section headers in the assembly.
60
58
====
61
-
<4> You must include a blank line after H1 ("Level 0" in AsciiDoc terminology) headings.
62
-
<5> Includes attributes common to OpenShift docs.
59
+
<4> Includes attributes common to OpenShift docs.
63
60
+
64
61
[NOTE]
65
62
====
@@ -70,21 +67,18 @@ Section headers within the assembly must be H2 ("Level 1" in AsciiDoc terminolog
70
67
----
71
68
:_mod-docs-content-type: ASSEMBLY
72
69
include::_attributes/common-attributes.adoc[]
73
-
74
70
[id="installing-ibm-cloud-private"]
75
71
= Installing a private cluster on {ibm-cloud-title}
76
-
77
72
:context: installing-ibm-cloud-private
78
73
79
74
toc::[]
80
75
----
81
76
====
82
-
<6> You must include a blank line after each `include::` statement.
83
-
<7> Context used for identifying headers in modules that is the same as the anchor ID. Use lowercase and hyphens, for example `cli-developer-commands`.
84
-
<8> A blank line. You *must* have a blank line here before the `toc::[]`.
77
+
<5> Context used for identifying headers in modules that is the same as the anchor ID. Use lowercase and hyphens, for example `cli-developer-commands`.
78
+
<6> A blank line. You *must* have a blank line here before the `toc::[]`.
85
79
+
86
80
After the heading block and a single whitespace line, you can include any content for this assembly.
87
-
<9> The table of contents for the current assembly.
81
+
<7> The table of contents for the current assembly.
0 commit comments