Skip to content

Commit 5d47186

Browse files
authored
Merge pull request #103436 from skopacz1/guidelines_fix
OSDOCS-x: reverting assembly metadata rules
2 parents e48c114 + 8491118 commit 5d47186

File tree

1 file changed

+7
-13
lines changed

1 file changed

+7
-13
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,10 @@ Every assembly file must contain the following metadata at the top, with no blan
3939
:_mod-docs-content-type: ASSEMBLY <1>
4040
[id="<assembly-anchor-id>"] <2>
4141
= Assembly title <3>
42-
<4>
43-
include::_attributes/common-attributes.adoc[] <5>
42+
include::_attributes/common-attributes.adoc[] <4>
43+
:context: <assembly-context> <5>
4444
<6>
45-
:context: <assembly-context> <7>
46-
<8>
47-
toc::[] <9>
45+
toc::[] <7>
4846
----
4947
<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.
5048
<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>
5856
* The assembly title, which is the first line of the document, is the only level 1 ( `=` ) title.
5957
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.
6058
====
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.
6360
+
6461
[NOTE]
6562
====
@@ -70,21 +67,18 @@ Section headers within the assembly must be H2 ("Level 1" in AsciiDoc terminolog
7067
----
7168
:_mod-docs-content-type: ASSEMBLY
7269
include::_attributes/common-attributes.adoc[]
73-
7470
[id="installing-ibm-cloud-private"]
7571
= Installing a private cluster on {ibm-cloud-title}
76-
7772
:context: installing-ibm-cloud-private
7873
7974
toc::[]
8075
----
8176
====
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::[]`.
8579
+
8680
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.
8882

8983
[id="module-file-metadata"]
9084
== Module file metadata

0 commit comments

Comments
 (0)