-
Task
-
Resolution: Done
-
Normal
-
CRW 2.12
Should che-docs be using the official language, which is covered in
openshift/openshift-docs/contributing_to_docs/doc_guidelines.adoc?
== Indicating Technology Preview features
To indicate that a feature is in Technology Preview, include the
`modules/technology-preview.adoc` file in the feature's assembly to keep the
supportability wording consistent across Technology Preview features and provide a value for the :FeatureName: variable before you include this module.
See
link:[https://github.com/openshift/openshift-docs/pull/13878/files#diff-615ba1bf3b09d11a9c2604b775aa32f2[an]
example] of how this is applied.
This is a followup task on this comment: https://github.com/eclipse/che-docs/pull/2125/files#r722133845
—
Scoping
- Create an example file `snip_che-techology-preview.adoc` in the upstream repository (main branch), containing the standardized text we want for technology preview admonitions. Destination: https://github.com/eclipse-che/che-docs/tree/main/modules/administration-guide/examples/. You can get inspiration from: https://github.com/eclipse-che/che-docs/blob/master/modules/administration-guide/examples/snip_using-devworkspace-warning.adoc (but the content should be more generic).
- Create the corresponding `snip_crw-techology-preview.adoc` file in the downstream repository, in https://gitlab.cee.redhat.com/red-hat-developers-documentation/red-hat-devtools/-/tree/master/docs/topics/crw/administration-guide/examples You can get inspiration from: https://gitlab.cee.redhat.com/red-hat-developers-documentation/red-hat-devtools/-/blob/master/docs/topics/crw/releases-notes/ref_issue-CRW-2357.adoc (but the content should be more generic).