Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue with k8s.io/docs/concepts/overview/working-with-objects/names/ #16141

Closed
dsbos opened this issue Aug 29, 2019 · 2 comments · Fixed by #16202
Closed

Issue with k8s.io/docs/concepts/overview/working-with-objects/names/ #16141

dsbos opened this issue Aug 29, 2019 · 2 comments · Fixed by #16202
Labels
priority/backlog Higher priority than priority/awaiting-more-evidence.

Comments

@dsbos
Copy link
Contributor

dsbos commented Aug 29, 2019

Problem:

The wording:

All objects in the Kubernetes REST API are unambiguously identified by a Name and a UID.

is a bit unclear.

The wording isn't ambiguous between the meanings:

  1. each object is unambiguously identified by a Name and is unambiguously identified by a UID,
  2. each object is unambiguously identified by the combination of a Name and a UID.

Also, mixing plural "objects" with a characteristic of each object (e.g., "a name") is a bit ambiguous or confusing too.

(Yes, readers can probably figure it out, but let's be clear to start with, so that readers don't have to slow down to resolve the ambiguity and can proceed with absorbing what the documentation is trying to tell them.)

Proposed Solution:

State more clearly what is intended to be conveyed.

The cardinalities would be much clearer if that text referred to "each object", as in:

Each object in the Kubernetes REST API is unambiguously identified by ...

Page to Update:
https://kubernetes.io/...

@aimeeu
Copy link
Contributor

aimeeu commented Aug 30, 2019

Thanks for your feedback, @dsbos. Would you be willing to put the desired changes in a pull request?

@sftim
Copy link
Contributor

sftim commented Sep 10, 2019

/priority backlog

@k8s-ci-robot k8s-ci-robot added the priority/backlog Higher priority than priority/awaiting-more-evidence. label Sep 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority/backlog Higher priority than priority/awaiting-more-evidence.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants