docs: clarify the operator design doc a bit #167
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
obnoxxx
force-pushed
the
design-crd-vs-cr
branch
from
a9e3763 to
d37b777
Compare
nb-ohad
requested changes
Nov 7, 2024
I the operator design document, custom resource definition(CRD) seems to have been used as a synonym for custom resource(CR) which is usually not correct. This change makes the wording a little clearer by using CRD only when technically correct and using CR when appropriate. Signed-off-by: Michael Adam <[email protected]> Update docs/design/operator.md Co-authored-by: nb-ohad <[email protected]>
obnoxxx
force-pushed
the
design-crd-vs-cr
branch
from
139c4e3 to
93f5bbc
Compare
nb-ohad
approved these changes
Nov 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I the operator design document, custom resource definition(CRD) seems to have been used as a synonym for custom resource(CR) which is usually not correct.
This change makes the wording a little clearer by using CRD only when technically correct and using CR when appropriate.
Describe what this PR does
Make some wording in the operator design doc a little clearer and more correct.
Is there anything that requires special attention
no
Do you have any questions?
no
Is the change backward compatible?
yes
Are there concerns around backward compatibility?
no
Provide any external context for the change, if any.
none
Related issues
none
Future concerns
none
Checklist:
guidelines in the developer
guide.
Request
notes
updated with breaking and/or notable changes for the next major release.