Skip to content

HDDS-15260. Escape more elements in xml_to_md.py#10311

Merged
adoroszlai merged 2 commits into
apache:masterfrom
sarvekshayr:HDDS-15260
May 19, 2026
Merged

HDDS-15260. Escape more elements in xml_to_md.py#10311
adoroszlai merged 2 commits into
apache:masterfrom
sarvekshayr:HDDS-15260

Conversation

@sarvekshayr
Copy link
Copy Markdown
Contributor

What changes were proposed in this pull request?

Docusaurus build fails for update with <= in config property's description:

"Unexpected character `=` (U+003D) before name, expected a character that can start a name, such as a letter, `$`, or `_`"

There may be other characters or patterns to escape.

Escapes characters (&, <, >) in addition to the existing {...} placeholder sanitisation to prevent MDX/JSX parsing errors in config values and descriptions.

What is the link to the Apache JIRA

HDDS-15260

How was this patch tested?

Configurations.md generated from CI.

| Minimum fraction of volume capacity reserved for local enforcement: writes fail when available space would drop below max(this ratio * capacity, `hdds.datanode.volume.min.free.space`). Should be &lt;= min.free.space.percent so SCM can plan for a larger headroom than the DN enforces locally. |

Rendered view
Screenshot 2026-05-19 at 4 30 25 PM

@sarvekshayr sarvekshayr requested a review from adoroszlai May 19, 2026 11:04
Copy link
Copy Markdown
Contributor

@adoroszlai adoroszlai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @sarvekshayr for the patch.

@adoroszlai adoroszlai merged commit c917a6e into apache:master May 19, 2026
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants