You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or 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
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.
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.
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.
Needs approval from an approver in each of these files:
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 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!
cncf-cla: noIndicates the PR's author has not signed the CNCF CLA.kind/documentationCategorizes issue or PR as related to documentation.release-noteDenotes a PR that will be considered when it comes time to generate release notes.size/XXLDenotes a PR that changes 1000+ lines, ignoring generated files.
2 participants
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.
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?
Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.: