Skip to content

Commit a7ceb25

Browse files
authored
Merge pull request #13654 from adellape/contrib_prodver4
Add major version # usage to contrib
2 parents 6c5846a + da80d34 commit a7ceb25

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ instead.
7979
=== Unique IDs
8080

8181
The content in this repo is used to build docs that publish to multiple
82-
locations (e.g., docs.openshift.com, docs.openshift.org, and the Red Hat
82+
locations (e.g., docs.openshift.com, docs.okd.io, and the Red Hat
8383
Customer Portal). While heading IDs will be created automatically from any
8484
section titles (e.g., "Managing Authorization Policies" would generate an ID of
8585
`managing-authorization-policies`, which would act as an anchor reference), we
@@ -119,7 +119,7 @@ ID. For example:
119119
== Managing Authorization Policies
120120
----
121121

122-
== Product Name & Version Attributes
122+
== Product Name & Version
123123

124124
When possible, generalize references to the product name and/or version using
125125
the `{product-title}` and/or `{product-version}` attributes. These attributes
@@ -140,16 +140,16 @@ possible values for `{product-title}` and `{product-version}`.
140140
|Distro |`{product-title}` |`{product-version}`
141141

142142
|`openshift-origin`
143-
|OpenShift Origin
144-
|Latest
143+
|OKD
144+
|1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 3.6, 3.7, 3.9, 3.10, 3.11, Latest
145145

146146
|`openshift-enterprise`
147-
|OpenShift Enterprise
148-
|3.1, 3.0
147+
|OpenShift Container Platform
148+
|3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.9, 3.10, 3.11
149149

150150
|`openshift-dedicated`
151151
|OpenShift Dedicated
152-
|3.1, 3.0
152+
|Latest
153153

154154
|`openshift-online`
155155
|OpenShift Online
@@ -168,19 +168,29 @@ statement] is not necessary. For example, if you were viewing a build for the
168168
`openshift-enterprise` distro (for any of the distro-defined branches), this
169169
would render as:
170170

171-
"You can deploy applications on OpenShift Enterprise."
171+
"You can deploy applications on OpenShift Container Platform."
172172

173173
And for the `openshift-origin` distro:
174174

175-
"You can deploy applications on OpenShift Origin."
175+
"You can deploy applications on OKD."
176176

177177
Considering that we use distinct branches to keep content for product versions
178178
separated, global use of `{product-version}` across all branches is probably
179179
less useful, but it is available if you come across a need for it. Just consider
180180
how it will render across any branches that the content appears in.
181181

182+
If it makes more sense in context to refer to the major version of the product
183+
instead of a specific minor version (for example, if comparing how something in
184+
OCP 4 differs from OCP 3), just use the major version number. Do not prepend
185+
with a `v`, as in `v3` or `v4`.
186+
182187
Do not use markup in headings.
183188

189+
*Do not use internal company server names in command or example output*. See
190+
suggested host name examples
191+
https://docs.openshift.com/container-platform/3.11/install/example_inventories.html#multi-masters-single-etcd-using-native-ha[here].
192+
193+
184194
== Links, Hyperlinks, and Cross References
185195
Links can be used to cross-reference internal topics, or send customers to external information resources for further reading.
186196

0 commit comments

Comments
 (0)