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

Document different patch types #2326

Open
roycaihw opened this issue Jan 17, 2025 · 2 comments
Open

Document different patch types #2326

roycaihw opened this issue Jan 17, 2025 · 2 comments
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation.

Comments

@roycaihw
Copy link
Member

This client supports multiple patch types (JSON patch, SMP, apply patch). See source code.

Our existing example isn't clear about what patch type is being used and what are the alternatives.

We should have a document explains the different patch types, and have examples showing how to use them. Upstream Kubernetes also has related documents like this one.

This documentation could be helpful for issues like

The doc can be submitted to https://github.com/kubernetes-client/python/tree/master/devel and/or https://github.com/kubernetes-client/python/tree/master/doc

@roycaihw roycaihw added good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. labels Jan 17, 2025
@h-ema-r
Copy link

h-ema-r commented Jan 18, 2025

Hello sir, I would like to work on this issue and create documentation to explain the different patch types with examples.

@userxpartha
Copy link

hello mentor i would like to work on this issue so ,could you please guide me to so that i can contribute .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

No branches or pull requests

3 participants