MonkeyCanCode commented on code in PR #3738:
URL: https://github.com/apache/polaris/pull/3738#discussion_r2796693563
##########
Makefile:
##########
@@ -219,8 +219,8 @@ helm-doc-generate: DEPENDENCIES := helm-docs
.PHONY: helm-doc-generate
helm-doc-generate: check-dependencies ## Generate Helm chart documentation
@echo "--- Generating Helm documentation ---"
- @helm-docs --chart-search-root=helm
- @$(PYTHON) helm/polaris/tools/prepare_helm_readme.py
helm/polaris/README.md site/content/in-dev/unreleased/helm.md
+ @helm-docs --chart-search-root=helm --template-files helm.md.gotmpl
--output-file helm.md
Review Comment:
So couple things here. The `--output-file` is relative path to the same
location as template-files...so technically, we can do `helm-docs
--chart-search-root=helm --template-files helm.md.gotmpl --output-file
../../site/content/in-dev/unreleased/helm.md` to get it to the right path. It
is a bit ugly but I do agreed that is better then have two steps.
The previous reason on why I kept it two steps was due to we are using those
blockquote render hooks for hugo which is not actually valid as go template is
used by for helm-doc to render (the `<` in the blockquote render hooks). But we
can escape those to tell go to treat them as string literal. It will make the
doc a bit harder to read but I also think it is better than depends on another
python script for the post-processing and extra file copy.
--
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]
