-
Task
-
Resolution: Obsolete
-
Major
-
None
-
OSSM 2.0.0, OSSM 2.1.0, OSSM 2.2.0
-
5
-
False
-
False
-
Undefined
-
Review and update Service Mesh and Jaeger docs according to the new OpenShift style guidelines for API object terms.
Style Guidelines - [https://github.com/openshift/openshift-docs/blob/master/contributing_to_docs/doc_guidelines.adoc#api-object-formattin
https://github.com/openshift/openshift-docs/blob/master/contributing_to_docs/doc_guidelines.adoc#api-object-formatting]
|
Book assignments are here: https://docs.google.com/spreadsheets/d/1SUYWAt8Ib6EKhr6YebbxdivO0ub5y_Oo5rQoYk46rCQ/edit#gid=0
We are updating all supported 4.x versions (4.6 - 4.11) to prevent future cherry picking issues.
- pod vs Pod (316 results)
- node vs Node (267 results)
- daemon set (I think this only appears as lower case, because we do not support daemon set) (16 results)
- config map (I think this only appears as lower case, since we only talk about config maps in general) (no results, 49 for configmap)
- deployment vs Deployment (275 results)
- image stream (I don't think this appears in our docs?) (NONE)
- persistent volume claim (I don't think this appears in our docs?) (NONE)
Approach - we started out always capitalizing, but since we're mostly talking about these objects in general, I would search for capitals and unless you're talking about a specific configuration file (Edit the bookinfo Deployment file), I would remove the capitalization.
- is cloned by
-
OBSDOCS-40 Implement OpenShift Terminology changes in distributed tracing docs
- Backlog