You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contributing_to_docs/doc_guidelines.adoc
+34Lines changed: 34 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,6 +59,11 @@ toc::[] <7>
59
59
<6> A blank line. You *must* have a blank line here before the toc.
60
60
<7> The table of contents for the current assembly.
61
61
62
+
[NOTE]
63
+
====
64
+
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.
65
+
====
66
+
62
67
After the heading block and a single whitespace line, you can include any content for this assembly.
63
68
64
69
[NOTE]
@@ -101,6 +106,11 @@ Example:
101
106
= Basic CLI commands
102
107
----
103
108
109
+
[NOTE]
110
+
====
111
+
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.
112
+
====
113
+
104
114
[id="snippet-file-metadata"]
105
115
== Text snippet file metadata
106
116
Every text snippet should be placed in the `snippets/` folder and should contain the following metadata at the top:
@@ -247,6 +257,8 @@ Do not use "Overview" as a heading.
247
257
248
258
Do not use backticks or other markup in assembly or module headings.
249
259
260
+
Do not use special characters or symbols in titles. Symbols and special characters in titles can cause rendering errors in the HTML output.
261
+
250
262
Use only one level 1 heading (`=`) in any file.
251
263
252
264
=== Discrete headings
@@ -538,6 +550,28 @@ If it makes more sense in context to refer to the major version of the product i
538
550
Other common attribute values are defined in the `_attributes/common-attributes.adoc` file. Where possible, generalize references to those values by using the common attributes. For example, use `{cluster-manager-first}` to refer to Red Hat OpenShift Cluster Manager. If you need to add an attribute to the `_attributes/common-attributes.adoc` file, open a pull request to add it to the attribute list. Do not create a separate attributes file without first consulting the docs team.
539
551
====
540
552
553
+
[id="third-party-vendor-product-names"]
554
+
== Third-party vendor product names
555
+
556
+
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.
557
+
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.
559
+
560
+
Choose any of the following sources for clarification on using the symbol for a specific third-party vendor product name:
561
+
562
+
* Visit the third-party vendor's website and contact them directly.
563
+
* Contact internal Red Hat product teams or integrated third-party vendor teams.
564
+
* Contact the Red Hat Legal team. Only consider this option when the other two options did not provide clear context for your query.
565
+
566
+
[IMPORTANT]
567
+
====
568
+
Do not use Asciidoctor character replacement substitutions, which rely on a Unicode code point such as _®_, to set the registered symbol in an Asciidoc file. Instead use _(R)_ beside the product name. For example, `IBM(R) LinuxONE`.
569
+
570
+
Do not apply any superscript, such as `(R)`, or subscript formatting to module or assembly headings.
571
+
====
572
+
573
+
For more information about contacting the Red Hat's Legal team, see link:https://source.redhat.com/departments/legal/redhatintellectualproperty/trademarks/trademarks_and_domain_names_wiki/copyright_notices_and_trademark_legends[Copyright Notices and Trademark Legends] on the The Source.
0 commit comments