Skip to content

Conversation

@alex-hunt-materialize
Copy link
Contributor

publish helm chart information when bumping versions

Motivation

Tips for reviewer

Checklist

  • This PR has adequate test coverage / QA involvement has been duly considered. (trigger-ci for additional test/nightly runs)
  • This PR has an associated up-to-date design doc, is a design doc (template), or is sufficiently small to not require a design.
  • If this PR evolves an existing $T ⇔ Proto$T mapping (possibly in a backwards-incompatible way), then it is tagged with a T-proto label.
  • If this PR will require changes to cloud orchestration or tests, there is a companion cloud PR to account for those changes that is tagged with the release-blocker label (example).
  • If this PR includes major user-facing behavior changes, I have pinged the relevant PM to schedule a changelog post.

(
cat <<'EOF'
---
description: "Reference page on the Materialize Operator Helm Chart"
Copy link
Contributor

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.
---
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.

Copy link
Contributor

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)

Copy link
Contributor Author

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

Is it not rendering for you?
It isn't included in the left-hand nav.

Screenshot 2025-11-17 at 8 11 24 AM

Copy link
Contributor Author

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.

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