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

Quickly-fixable typo #794

Open
faangbait opened this issue Nov 17, 2024 · 3 comments
Open

Quickly-fixable typo #794

faangbait opened this issue Nov 17, 2024 · 3 comments
Labels
type/documentation Improvements or additions to documentation

Comments

@faangbait
Copy link

SUMMARY

kubernetes.core.k8s.state reads "If set to present, an existing object will be patched, if its attributes differ from those specified using resource_definition or src."

Should read "If set to patched, an existing object will be patched, if its attributes differ from those specified using resource_definition or src.

ISSUE TYPE
  • Documentation Report
COMPONENT NAME

k8s

ANSIBLE VERSION
latest
@alinabuzachis
Copy link
Contributor

@faangbait Thank you for raising this issue. Would you be willing to open a Pull Request with a fix?

@alinabuzachis alinabuzachis added the type/documentation Improvements or additions to documentation label Nov 18, 2024
@gravesm
Copy link
Member

gravesm commented Nov 18, 2024

I believe the documentation is correct, it's just poorly worded. The present state will both create a resource if it doesn't exist and patch a resource if it does exist and differs from the supplied resource. The patched state will only patch an existing resource.

@faangbait
Copy link
Author

@faangbait Thank you for raising this issue. Would you be willing to open a Pull Request with a fix?

If I knew how to phrase it, I would. Per @gravesm's comment, it needs a bit of nuance from a SME.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants