Improve generated documentation for load balancer fields#3734
Conversation
|
Hi @rajeshd2091. Thanks for your PR. I'm waiting for a istio member to verify that this patch is reasonable to test. If it is, they should reply with Regular contributors should join the org to skip this step. Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions 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. |
|
/ok-to-test |
|
/test release-notes |
|
Hey @rajeshd2091, to ask for a review from the TOC, I suggest you ping the members in the slack channel |
This PR improves the generated API documentation for
TrafficPolicy.LoadBalancerby adding and refining proto comments for its fields.Problem
DestinationRule.spec.trafficPolicy.loadBalancerappeared with<no description>inkubectl explainChanges
simplefield at correct place.consistent_hashfield at correct place.locality_lb_settingcomment formatting by adding a terminating period, allowing the generator to recognize the summary correctly.Validation
Verified that the updated comments are reflected in:
kubectl explain destinationrule.spec.trafficPolicy.loadBalancerThe affected fields now display meaningful descriptions instead of

<no description>: