Skip to content

Commit 06c32fe

Browse files
authored
Merge pull request #68974 from abhatt-rh/module-metadata
Doc guidelines: Correcting the order of the callout description
2 parents 91e3b84 + 0f5371a commit 06c32fe

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,13 +82,13 @@ Every module should be placed in the modules folder and should contain the follo
8282
//
8383
// * list of assemblies where this module is included <1>
8484
85-
:_mod-docs-content-type: <TYPE> <2>
85+
:_mod-docs-content-type: <TYPE> <2>
8686
[id="<module-anchor>_{context}"] <3>
8787
= Module title <4>
8888
----
8989

90-
<1> The content type for the file. Replace `<TYPE>` with the actual type of the module, `CONCEPT`, `REFERENCE`, or `PROCEDURE`. Place this attribute before the anchor ID or, if present, the conditional that contains the anchor ID.
91-
<2> List of assemblies in which this module is included.
90+
<1> List of assemblies in which this module is included.
91+
<2> The content type for the file. Replace `<TYPE>` with the actual type of the module, `CONCEPT`, `REFERENCE`, or `PROCEDURE`. Place this attribute before the anchor ID or, if present, the conditional that contains the anchor ID.
9292
<3> A module anchor with {context} that must be lowercase and must match the module's file name.
9393
<4> Human readable title. To ensure consistency in the results of the
9494
leveloffset values in include statements, you must use a level one heading
@@ -555,7 +555,7 @@ Other common attribute values are defined in the `_attributes/common-attributes.
555555

556556
Red Hat integrates with many third-party vendor products. For certain integrated products, third-party vendor staff might have access to certain Red Hat resources and be contactable within Red Hat. On other occasions, common open-source products might be widely used across IT infrastructure providers, so Red Hat might not have direct contacts to organizations that own these products.
557557

558-
Depending on the third-party vendor's requirements, you might need to add a registered trademark symbol to all of the vendor's product names or only on the first occurence of referencing the product name in an assembly, a module, or a document.
558+
Depending on the third-party vendor's requirements, you might need to add a registered trademark symbol to all of the vendor's product names or only on the first occurence of referencing the product name in an assembly, a module, or a document.
559559

560560
Choose any of the following sources for clarification on using the symbol for a specific third-party vendor product name:
561561

0 commit comments

Comments
 (0)