MonkeyCanCode opened a new pull request, #3232: URL: https://github.com/apache/polaris/pull/3232
<!-- ๐ Describe what changes you're proposing, especially breaking or user-facing changes. ๐ See https://github.com/apache/polaris/blob/main/CONTRIBUTING.md for more. --> The original functionality of `make helm-doc-generate` was simply copy helm doc from helm path into hugo path (introduced as part of https://github.com/apache/polaris/pull/2027). But due to issues with rendering, we had to change admonitions from Markdown style to Hugo style. Currently this is done manually and can be fairly tedious when we are adding changes to the helm repo as `make helm-doc-generate` will undo these changes (see discussion in https://github.com/apache/polaris/pull/2939 where we bring this issue up). To avoid manual edit, I proposed we use a simple python script to handle admonitions conversion from Markdown style to Hugo style. Sample command to show no content changes now if we tried to use this make command to regenerate helm doc: ``` โ polaris git:(fix_helm_doc_script) make helm-doc-generate --- Checking for requested dependencies --- Checking for helm-docs... helm-docs is installed. --- All checks complete. --- --- Generating Helm documentation --- INFO[2025-12-07T17:40:48-06:00] Found Chart directories [polaris] INFO[2025-12-07T17:40:48-06:00] Generating README Documentation for chart helm/polaris --- Helm documentation generated and copied --- โ polaris git:(fix_helm_doc_script) git status On branch fix_helm_doc_script Your branch is up to date with 'origin/fix_helm_doc_script'. nothing to commit, working tree clean ``` ## Checklist - [x] ๐ก๏ธ Don't disclose security issues! (contact [email protected]) - [x] ๐ Clearly explained why the changes are needed, or linked related issues: Fixes # - [x] ๐งช Added/updated tests with good coverage, or manually tested (and explained how) - [x] ๐ก Added comments for complex logic - [x] ๐งพ Updated `CHANGELOG.md` (if needed) - [x] ๐ Updated documentation in `site/content/in-dev/unreleased` (if needed) -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
