Readme #321
Readme #321
Conversation
Signed-off-by: Philip Obiora <73377830+Philip-21@users.noreply.github.com>
Signed-off-by: Philip-21 <philipuzomaobiora@gmail.com>
Signed-off-by: Philip-21 <philipuzomaobiora@gmail.com>
|
@leecalcote i was able to take some time yesterday to go through the utils package and make some documentation on some packages . You can look through it and tell me what you think , i am still going to add more descriptions for other packages. |
utils/readme.md
Outdated
| Here is a brief description of some of the packages embedded in Utils: | ||
|
|
||
|
|
||
| ### Kuberentes |
There was a problem hiding this comment.
Does this line work well? Why add a blank before it?
There was a problem hiding this comment.
The aspects where i left spaces are where i will add descriptions for other packages , i just pushed this pr for reviews on the descriptions i've made.
There was a problem hiding this comment.
I am not sure I got your point, but please follow the syntax of markdown.
There was a problem hiding this comment.
Alright ,
from this commit i just pushed i think i have made adjustment to the spaces .
utils/readme.md
Outdated
| Overall, the describe package provides a convenient way to retrieve detailed information about Kubernetes resources in a standardized format. | ||
|
|
||
|
|
||
| ##### Expose |
utils/readme.md
Outdated
| - The <code>Expose()</code> is the main function of the package this takes a Kubernetes clientset, REST config, Config object, and a list of resources to expose. | ||
| - It uses a Traverser to iterate over the resources and generate the corresponding services. | ||
| Overall, this package provides a way to expose Kubernetes resources as services with customizable configurations. | ||
|
|
There was a problem hiding this comment.
Why there are so many blanks here?
Signed-off-by: Philip-21 <philipuzomaobiora@gmail.com>
Signed-off-by: Philip-21 <philipuzomaobiora@gmail.com>
Signed-off-by: Philip-21 <philipuzomaobiora@gmail.com>
|
@Aisuko i have made adjustments on the spaces and blanks . |
|
Thanks @leecalcote |
Description
This PR fixes #
Pull Request for Utils package Documentation #286
Notes for Reviewers
Signed commits