Skip to content

fix(gen-apidocs): unescape HTML entities in markdown generator descriptions - #466

Open
aman0408 wants to merge 1 commit into
kubernetes-sigs:masterfrom
aman0408:unescape-html-entities
Open

fix(gen-apidocs): unescape HTML entities in markdown generator descriptions#466
aman0408 wants to merge 1 commit into
kubernetes-sigs:masterfrom
aman0408:unescape-html-entities

Conversation

@aman0408

@aman0408 aman0408 commented Jul 26, 2026

Copy link
Copy Markdown

What type of PR is this?

/kind bug

What this PR does / why we need it:

Unescapes HTML entities (such as ", &, <, >) in field and resource descriptions rendered by gen-apidocs/generators/markdown.go.

During configuration loading, OpenAPI descriptions are HTML-escaped into DescriptionWithEntities. While the HTML backend (html.go) relies on web browsers to natively decode these entities when rendering HTML elements (<TD> / <P>), Hugo's Markdown parser (goldmark) emits HTML entities literally when they appear inside Markdown code spans or table cells (e.g. rendering `Name: &#34;mysvc&#34;` on kubernetes.io).

Un-escaping descriptions before generating Markdown pages ensures clean, human-readable text and code blocks across the generated reference pages.

Which issue(s) this PR fixes:

Ref kubernetes/website#56418

Example affected page: Core v1 Endpoints

Does this PR introduce a user-facing change?

NONE

…ptions

Unescape HTML entities like &kubernetes-sigs#34; and &amp; in field and resource descriptions so that Hugo renders clean Markdown without raw entity codes.

Ref kubernetes/website#56418
@kubernetes-prow

Copy link
Copy Markdown
Contributor

Welcome @aman0408!

It looks like this is your first PR to kubernetes-sigs/reference-docs 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/reference-docs has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@kubernetes-prow kubernetes-prow Bot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 26, 2026
@kubernetes-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: aman0408
Once this PR has been reviewed and has the lgtm label, please assign jimangel for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubernetes-prow kubernetes-prow Bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 26, 2026
@Caesarsage

Copy link
Copy Markdown
Contributor

Thanks for the fix.

LGTM

I verified locally

image

@aman0408

Copy link
Copy Markdown
Author

@onlydole @divya-mohan0209 friendly ping to review the PR in case you missed it :)

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

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants