@@ -79,7 +79,7 @@ instead.
79
79
=== Unique IDs
80
80
81
81
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
83
83
Customer Portal). While heading IDs will be created automatically from any
84
84
section titles (e.g., "Managing Authorization Policies" would generate an ID of
85
85
`managing-authorization-policies`, which would act as an anchor reference), we
@@ -119,7 +119,7 @@ ID. For example:
119
119
== Managing Authorization Policies
120
120
----
121
121
122
- == Product Name & Version Attributes
122
+ == Product Name & Version
123
123
124
124
When possible, generalize references to the product name and/or version using
125
125
the `{product-title}` and/or `{product-version}` attributes. These attributes
@@ -140,16 +140,16 @@ possible values for `{product-title}` and `{product-version}`.
140
140
|Distro |`{product-title}` |`{product-version}`
141
141
142
142
|`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
145
145
146
146
|`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
149
149
150
150
|`openshift-dedicated`
151
151
|OpenShift Dedicated
152
- |3.1, 3.0
152
+ |Latest
153
153
154
154
|`openshift-online`
155
155
|OpenShift Online
@@ -168,19 +168,29 @@ statement] is not necessary. For example, if you were viewing a build for the
168
168
`openshift-enterprise` distro (for any of the distro-defined branches), this
169
169
would render as:
170
170
171
- "You can deploy applications on OpenShift Enterprise ."
171
+ "You can deploy applications on OpenShift Container Platform ."
172
172
173
173
And for the `openshift-origin` distro:
174
174
175
- "You can deploy applications on OpenShift Origin ."
175
+ "You can deploy applications on OKD ."
176
176
177
177
Considering that we use distinct branches to keep content for product versions
178
178
separated, global use of `{product-version}` across all branches is probably
179
179
less useful, but it is available if you come across a need for it. Just consider
180
180
how it will render across any branches that the content appears in.
181
181
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
+
182
187
Do not use markup in headings.
183
188
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
+
184
194
== Links, Hyperlinks, and Cross References
185
195
Links can be used to cross-reference internal topics, or send customers to external information resources for further reading.
186
196
0 commit comments