You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@ozone.apache.org by "sarvekshayr (via GitHub)" <gi...@apache.org> on 2026/02/28 06:01:06 UTC
[PR] HDDS-14736. Fix the {...} issue in xml_to_md.py and rename appendix.md. [ozone]
sarvekshayr opened a new pull request, #9846:
URL: https://github.com/apache/ozone/pull/9846
## What changes were proposed in this pull request?
The docusaurus/build-website check [fails](https://github.com/apache/ozone-site/actions/runs/22477214287/job/65106708567) in ozone-site repo for the automated-config-doc-update [PR](https://github.com/apache/ozone-site/pull/354).
It seems to have problem with {...} type text, treating them as reference. Updated xml_to_md.py to wrap curly brackets in backticks.
## What is the link to the Apache JIRA
[HDDS-14736](https://issues.apache.org/jira/browse/HDDS-14736)
## How was this patch tested?
CI: https://github.com/sarvekshayr/ozone/actions/runs/22514298313/job/65229799113
Fork ozone-site CI tested with the .md file generated with this change: https://github.com/sarvekshayr/ozone-site/actions/runs/22514589225
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For additional commands, e-mail: issues-help@ozone.apache.org
Re: [PR] HDDS-14736. Fix the {...} issue in xml_to_md.py and rename appendix.md. [ozone]
Posted by "adoroszlai (via GitHub)" <gi...@apache.org>.
adoroszlai merged PR #9846:
URL: https://github.com/apache/ozone/pull/9846
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For additional commands, e-mail: issues-help@ozone.apache.org
Re: [PR] HDDS-14736. Fix the {...} issue in xml_to_md.py and rename appendix.md. [ozone]
Posted by "adoroszlai (via GitHub)" <gi...@apache.org>.
adoroszlai commented on code in PR #9846:
URL: https://github.com/apache/ozone/pull/9846#discussion_r2867132417
##########
dev-support/ci/xml_to_md.py:
##########
@@ -107,9 +107,11 @@ def generate_markdown(properties):
"""
for prop in sorted(properties.values(), key=lambda p: p.name):
- # Escape pipe characters in description to prevent breaking the table
+ # Escape pipe characters and wrap {placeholders} in backticks
description = prop.description.replace('|', '\\|')
- value = prop.value if prop.value else ''
+ description = re.sub(r'(\$)?\{([^}]+)\}', r'`\1{\2}`', description)
+ value = prop.value.replace('|', '\\|') if prop.value else ''
+ value = re.sub(r'(\$)?\{([^}]+)\}', r'`\1{\2}`', value) if value else ''
Review Comment:
nit: it would be nice to `re.compile` the pattern before the loop
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For additional commands, e-mail: issues-help@ozone.apache.org