kubernetes-client
Visualization for the python codebase
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Generated documentation to help new developers to get up to speed with the python(k8s-client) codebase.
Me and a friend are trying to help the process of getting up-to-speed in new codebases. We wonder if you have some on-boarding process for people when they start working on new projects in k8s, it would be awesome to hear about that. We believe the best way to get started is through visualizations - for code that is diagrams, further we also think that them being up-to-date is important and tedious task.
All this said, I have generated diagrams leveraging static analysis and LLM's for this repository. You can see how the added change renders in the github markdown here - https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/python/on_boarding.md
Would love to hear your opinion on the diagrams, any feedback is more than welcome! Also it would be cool to see what your opinion on diagram driven documentation is?
I usually open discussions for this, but you don't have them enabled for this repository so I went ahead and opened a PR :)
Full disclosure: we're trying to turn this into a startup, but we're still in a very early stage and figuring out what will actually be useful for people.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
I would usually open discussions for this kind of topic, but it seems like they are not enabled for this repository so decided to open a PR.
Does this PR introduce a user-facing change?
Visualization for contributors of the python codebase.
Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:
- :x: - login: @ivanmilevtues / name: Ivan Milev . The commit (37fd5b99cbf33a3900ccf4a48d00648ff4440ccd) is not authorized under a signed CLA. Please click here to be authorized. For further assistance with EasyCLA, please submit a support request ticket.
![linux-foundation-easycla[bot] avatar](https://avatars.githubusercontent.com/in/17893?v=4 "Published by a pub.dev verified publisher"){kind=small}
[APPROVALNOTIFIER] This PR is NOT APPROVED
This pull-request has been approved by: ivanmilevtues Once this PR has been reviewed and has the lgtm label, please assign roycaihw for approval. For more information see the Code Review Process.
The full list of commands accepted by this bot can be found here.
Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment
Welcome @ivanmilevtues!
It looks like this is your first PR to kubernetes-client/python 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.
You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.
You can also check if kubernetes-client/python has its own contribution guidelines.
You may want to refer to our testing guide if you run into trouble with your tests not passing.
If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!
Thank you, and welcome to Kubernetes. :smiley:
@roycaihw: Closed this PR.
In response to this:
/close
Please feel free to reopen when you sign CLA
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.