Skip to content

Commit edf488b

Browse files
authored
Merge pull request #55780 from adellape/guidelines_backtick
2 parents a9eea48 + b8ea7d8 commit edf488b

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ toc::[] <7>
3636

3737
<1> The content type for the file. For assemblies, always use `:_content-type: ASSEMBLY`. Place this attribute before the anchor ID or, if present, the conditional that contains the anchor ID.
3838
<2> A unique (within OpenShift docs) anchor ID for this assembly. Use lowercase. Example: cli-developer-commands
39-
<3> Human readable title (notice the '=' top-level header)
39+
<3> Human readable title (notice the `=` top-level header)
4040
<4> Includes attributes common to OpenShift docs.
4141
+
4242
[NOTE]
@@ -345,7 +345,7 @@ link:https://redhat-documentation.github.io/modular-docs/#forming-assemblies[Red
345345
====
346346
When using the "Prerequisites", "Next steps", or "Additional resources" headings in an assembly, use `==` formatting, such as `== Prerequisites` or `== Additional resources`. Use of this heading syntax at the assembly level indicates that the sections relate to the whole assembly.
347347
348-
Only use `.` formatting (.Additional resources`) to follow a module in an assembly. Because you cannot use the xrefs in modules, this functions as a _trailing include_ at the assembly level, where the `.` formatting of the `include` statement indicates that the resource applies specifically to the module and not to the assembly.
348+
Only use `.` formatting (`.Additional resources`) to follow a module in an assembly. Because you cannot use the xrefs in modules, this functions as a _trailing include_ at the assembly level, where the `.` formatting of the `include` statement indicates that the resource applies specifically to the module and not to the assembly.
349349
====
350350

351351
== Writing concepts
@@ -1035,7 +1035,7 @@ syntax highlighting. For example:
10351035
be split up into three separate code blocks:
10361036
+
10371037
....
1038-
To create templates you can modify, run the following commands :
1038+
To create templates you can modify, run the following commands:
10391039
10401040
[source,terminal]
10411041
----

0 commit comments

Comments
 (0)