RedHatQuickCourses / rhoso-arch

Red Hat OpenStack Services on OpenShift Architecture (OpenStack-Admin-1)
https://redhatquickcourses.github.io/rhoso-arch/
2 stars 1 forks source link

Do not qualify all occurences of "api resource type" and "api resource instance" #8

Open flozanorht opened 2 months ago

flozanorht commented 2 months ago

Because they can refer to OpenStack APIs or Kubernetes APIs, it is sometimes required that we qualify them to make the context clear, which leads to cumbersome sentences, ex: "Kubernetes API resource type" and "OpenStack API resource instance" and it becomes worse when we refer to "custom resources" which are either "Kubernetes API custom resource types" or "Kubernetes API custom resource instances".

Pick a default for short references and add an admonition stating that the soft reference means which of the longer references. This belongs to ch1? or ch2?