-
Notifications
You must be signed in to change notification settings - Fork 482
publish helm chart information when bumping versions #34114
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: docs-upcoming-v26.0.0
Are you sure you want to change the base?
publish helm chart information when bumping versions #34114
Conversation
| ( | ||
| cat <<'EOF' | ||
| --- | ||
| description: "Reference page on the Materialize Operator Helm Chart" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As an FYI ... we're missing the title field here, which is why it doesn't render.
Also, we can probably simplify this:
- Don't bother with the front matter at all and just cat the README.md to doc/user/shared-content/operator-helm-chart-readme.md
- Just have a static doc/user/content/installation/appendix-.... .md:
- it has the front matter and includes the shared-content
This way, if we need to tweak the front matter, the script doesn't need to change.
- it has the front matter and includes the shared-content
---
title: "Appendix: Materialize Operator Helm Chart Readme"
description: "Readme page on the Materialize Operator Helm Chart"
disable_list: true
menu:
main:
identifier: ""
weight: 99
---
{{< include-md file="shared-content/operator-helm-chart-readme.md" >}}
And, I think we probably want to clean up the readme a bit? and I talked with @jubrad yesterday ... w.r.t. the the config options ... we currently have them displayed both as a table with the param and default value and a section below that has more description. https://materialize.com/docs/installation/configuration/#configure-the-materialize-operator ... the reason for this is to avoid having users scroll.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh ... and now reviewing the CRD reference generation page, I should meantion, @jubrad it doesn't havae to be .yml ... if it's easier for you all to use array of json docs, that's fine too (we'll just need to tweak the short codes)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried using the include-md short code, and it just threw a hugo error.
Is it not rendering for you? It renders for me locally. I removed the title because it was redundant to the headers in the readme.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, you're right. It shows up if the title is there when starting hugo, but it doesn't update if that changes.
I can make a new template with the tweaks. I just thought the existing readme was good enough.

publish helm chart information when bumping versions
Motivation
Tips for reviewer
Checklist
$T ⇔ Proto$Tmapping (possibly in a backwards-incompatible way), then it is tagged with aT-protolabel.