Skip to content

Commit aa23376

Browse files
authored
Merge pull request #41477 from adellape/tp_guideline_snippet
2 parents d7815a7 + e41db37 commit aa23376

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Example:
9292

9393
[id="snippet-file-metadata"]
9494
== Text snippet file metadata
95-
Every text snippet should be placed in the snippets folder and should contain the following metadata at the top:
95+
Every text snippet should be placed in the `snippets/` folder and should contain the following metadata at the top:
9696

9797
----
9898
// Text snippet included in the following assemblies: <1>
@@ -107,7 +107,7 @@ Every text snippet should be placed in the snippets folder and should contain th
107107
----
108108
<1> List of assemblies in which this text snippet is included.
109109
<2> List of modules in which this text snippet is included.
110-
<1> The content type for the file. For snippets, always use `:_content-type: SNIPPET`. Place this attribute before the anchor ID, the conditional that contains the anchor ID, or the first line of body text.
110+
<3> The content type for the file. For snippets, always use `:_content-type: SNIPPET`. Place this attribute before the anchor ID, the conditional that contains the anchor ID, or the first line of body text.
111111

112112
[NOTE]
113113
====
@@ -690,15 +690,17 @@ You must get approval from the Engineering, QE, and Docs teams before embedding
690690

691691
== Indicating Technology Preview features
692692

693-
To indicate that a feature is in Technology Preview, include the
694-
`snippets/technology-preview.adoc` file in the feature's assembly to keep the
695-
supportability wording consistent across Technology Preview features and provide a value for the :FeatureName: variable before you include this module.
693+
To indicate that a feature is in Technology Preview, include the `snippets/technology-preview.adoc` file in the feature's assembly or module to keep the supportability wording consistent across Technology Preview features. Provide a value for the `:FeatureName:` variable before you include this module.
696694

697-
See link:https://github.com/openshift/openshift-docs/pull/13878/files#diff-615ba1bf3b09d11a9c2604b775aa32f2[an example] of how this is applied.
695+
[source,text]
696+
----
697+
:FeatureName: The XYZ plug-in
698+
\include::snippets/technology-preview.adoc[]
699+
----
698700

699701
== Indicating deprecated features
700702

701-
To indicate that a feature is deprecated, include the `modules/deprecated-feature.adoc` file in the feature's assembly, or to each relevant assembly such as for a deprecated Operator, to keep the supportability wording consistent across deprecated features. Provide a value for the :FeatureName: variable before you include this module.
703+
To indicate that a feature is deprecated, include the `modules/deprecated-feature.adoc` file in the feature's assembly, or to each relevant assembly such as for a deprecated Operator, to keep the supportability wording consistent across deprecated features. Provide a value for the `:FeatureName:` variable before you include this module.
702704

703705
See link:https://github.com/openshift/openshift-docs/pull/31776/files[an example] of how this is applied.
704706

0 commit comments

Comments
 (0)