Improve generated documentation for load balancer fields#3734
Open
rajeshd2091 wants to merge 1 commit into
Open
Improve generated documentation for load balancer fields#3734rajeshd2091 wants to merge 1 commit into
rajeshd2091 wants to merge 1 commit into
Conversation
Collaborator
|
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. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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>: