istio icon indicating copy to clipboard operation
istio copied to clipboard

Enhance `genHTMLFragment` to Include Anchor Tags in Environment Variable Table Output

Open mike-weiner opened this issue 5 months ago • 2 comments

Please provide a description of this PR:

Resolves https://github.com/istio/istio.io/issues/16552.

This PR adds anchor link tags to the tool that generates the environment variable tables for the documentation of each CLI.

I tested this change by running make build followed by ./out/darwin_arm64/pilot-discovery collateral --html_fragment_with_front_matter.

This change outputs HTML in the following format:

<tr id='ambient-enable-multi-network'>
<td><a href='#ambient-enable-multi-network'><code>AMBIENT_ENABLE_MULTI_NETWORK</code></a></td>
<td>Boolean</td>
<td><code>false</code></td>
<td>If true, the multi-network functionality will be enabled.</td>
</tr>

I then took the HTML that was generated and ran in locally through the website via make serve from the istio.io repository.

mike-weiner avatar Jun 15 '25 01:06 mike-weiner

😊 Welcome @mike-weiner! This is either your first contribution to the Istio istio repo, or it's been a while since you've been here.

You can learn more about the Istio working groups, Code of Conduct, and contribution guidelines by referring to Contributing to Istio.

Thanks for contributing!

Courtesy of your friendly welcome wagon.

istio-policy-bot avatar Jun 15 '25 01:06 istio-policy-bot

/retest-required

mike-weiner avatar Jun 15 '25 01:06 mike-weiner