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
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,7 +92,7 @@ Example:
92
92
93
93
[id="snippet-file-metadata"]
94
94
== 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:
96
96
97
97
----
98
98
// 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
107
107
----
108
108
<1> List of assemblies in which this text snippet is included.
109
109
<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.
111
111
112
112
[NOTE]
113
113
====
@@ -690,15 +690,17 @@ You must get approval from the Engineering, QE, and Docs teams before embedding
690
690
691
691
== Indicating Technology Preview features
692
692
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.
696
694
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
+
----
698
700
699
701
== Indicating deprecated features
700
702
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.
702
704
703
705
See link:https://github.com/openshift/openshift-docs/pull/31776/files[an example] of how this is applied.
0 commit comments