openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-06 15:46:57 +01:00
Code Issues Releases Activity

Update guidance to not use markup in a Title for a block

Browse Source
This commit is contained in:
lbarbeevargas
2021-04-19 16:28:10 -04:00
parent ba684c4336
commit d5b92b212e
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
contributing_to_docs/doc_guidelines.adoc
View File

@@ -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).*