diff --git a/contributing_to_docs/doc_guidelines.adoc b/contributing_to_docs/doc_guidelines.adoc index 2f82f89c42..1c0d404608 100644 --- a/contributing_to_docs/doc_guidelines.adoc +++ b/contributing_to_docs/doc_guidelines.adoc @@ -106,7 +106,7 @@ use a gerund form in headings, such as: Do not use "Overview" as a heading. -Do not use backticks or other markup in headings. +Do not use backticks or other markup in assembly or module headings. === Discrete headings @@ -608,6 +608,11 @@ For all of the system blocks including table delimiters, use four characters. Fo ---- for code blocks .... +[NOTE] +==== +You can use backticks or other markup in the title for a block, such as a code block `.Example` or a table `.Description` title. +==== + === Code blocks, command syntax, and example output Code blocks are generally used to show examples of command syntax, example @@ -1165,7 +1170,7 @@ When referring to actual instances of API objects, use link:https://en.wikipedia [NOTE] ==== -Do not use backticks or other markup in headings. +Do not use backticks or other markup in assembly or module headings. You can use backticks or other markup in the title for a block, such as a code block `.Example` or a table `.Description` title. ==== Be sure to match the proper object type (or `kind` in Kubernetes terms); for example, do not add an "s" to make it plural. *Only follow this guidance if you are explicitly referring to the API object (for example, when editing an object in the CLI or viewing an object in the web console).*