|
1 | 1 | [id="contributing-to-docs-doc-guidelines"]
|
2 |
| -= Documentation guidelines |
3 | 2 | include::_attributes/common-attributes.adoc
|
| 3 | += Documentation guidelines |
4 | 4 | :toc: macro
|
5 | 5 |
|
6 | 6 | The documentation guidelines for OpenShift 4 build on top of the
|
@@ -37,23 +37,23 @@ Every assembly file should contain the following metadata at the top, with no li
|
37 | 37 | ----
|
38 | 38 | :_content-type: ASSEMBLY <1>
|
39 | 39 | [id="<unique-heading-for-assembly>"] <2>
|
40 |
| -= Assembly title <3> |
41 |
| -include::_attributes/common-attributes.adoc[] <4> |
| 40 | +include::_attributes/common-attributes.adoc[] <3> |
| 41 | += Assembly title <4> |
42 | 42 | :context: <unique-context-for-assembly> <5>
|
43 | 43 | <6>
|
44 | 44 | toc::[] <7>
|
45 | 45 | ----
|
46 | 46 |
|
47 | 47 | <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.
|
48 |
| -<2> A unique (within OpenShift docs) anchor ID for this assembly. Use lowercase. Example: cli-developer-commands |
49 |
| -<3> Human readable title (notice the `=` top-level header) |
50 |
| -<4> Includes attributes common to OpenShift docs. |
| 48 | +<2> A unique (within OpenShift docs) anchor ID for this assembly. Use lowercase. Example: cli-developer-commands. |
| 49 | +<3> Includes attributes common to OpenShift docs. |
51 | 50 | +
|
52 | 51 | [NOTE]
|
53 | 52 | ====
|
54 | 53 | The `{product-title}` and `{product-version}` common attributes are not defined in the `_attributes/common-attributes.adoc` file. Those attributes are pulled by AsciiBinder from the distro mapping definitions in the https://github.com/openshift/openshift-docs/blob/main/_distro_map.yml[_distro_map.yml] file. See xref:product-name-and-version[Product title and version] and xref:attribute-files[attribute files] for more information on this topic.
|
55 | 54 | ====
|
56 | 55 | +
|
| 56 | +<4> Human readable title (notice the `=` top-level header). |
57 | 57 | <5> Context used for identifying headers in modules that is the same as the anchor ID. Example: cli-developer-commands.
|
58 | 58 | <6> A blank line. You *must* have a blank line here before the toc.
|
59 | 59 | <7> The table of contents for the current assembly.
|
|
0 commit comments