Skip to content

Improve generated documentation for load balancer fields#3734

Open
rajeshd2091 wants to merge 1 commit into
istio:masterfrom
rajeshd2091:add-loadbalancer-description
Open

Improve generated documentation for load balancer fields#3734
rajeshd2091 wants to merge 1 commit into
istio:masterfrom
rajeshd2091:add-loadbalancer-description

Conversation

@rajeshd2091

Copy link
Copy Markdown

This PR improves the generated API documentation for TrafficPolicy.LoadBalancer by adding and refining proto comments for its fields.

Problem

  1. Some fields under DestinationRule.spec.trafficPolicy.loadBalancer appeared with <no description> in kubectl explain
image
  1. The generated API reference also omitted descriptions for the same fields, resulting in incomplete API documentation
image

Changes

  • Added a description for the simple field at correct place.
  • Added a description for the consistent_hash field at correct place.
  • Improved the locality_lb_setting comment 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.loadBalancer
  • Generated HTML documentation

The affected fields now display meaningful descriptions instead of <no description>:
image

@rajeshd2091 rajeshd2091 requested a review from a team as a code owner July 3, 2026 05:19
@istio-testing istio-testing added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. needs-ok-to-test labels Jul 3, 2026
@istio-testing

Copy link
Copy Markdown
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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-ok-to-test size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants