Skip to content

CRD documentation #34113

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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: docs-upcoming-v26.0.0
Choose a base branch
from
+1,797 −93
Draft

CRD documentation #34113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions doc/user/content/installation/appendix-materialize-crd-field-descriptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Appendix: Materialize CRD Field Descriptions"
description: "Reference page on Materialize CRD Fields"
menu:
main:
parent: "installation"
identifier: "appendix-materialize-crd-field-descriptions"
weight: 97
---

{{% self-managed/materialize-crd-descriptions %}}
489 changes: 489 additions & 0 deletions doc/user/data/self_managed/materialize_crd_descriptions.json
View file
Open in desktop

Large diffs are not rendered by default.

25 changes: 25 additions & 0 deletions doc/user/layouts/shortcodes/self-managed/materialize-crd-descriptions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{{ range $.Site.Data.self_managed.materialize_crd_descriptions }}
#### {{ index . 0 }}
<table>
<thead>
<tr>
<th>Field Name</th>
<th>Type</th>
<th>Default Value</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
{{ range (index . 1) }}
<tr>
<td><code>{{ .name }}</code></td>
<td><code>{{ .type }}</code></td>
<td><code>{{ .default }}</code></td>
<td><code>{{ .required }}</code></td>
<td>{{ .description }}</td>
</tr>
{{ end }}
</tbody>
</table>
{{ end }}
Comment on lines +1 to +25
Copy link
Contributor

@kay-kim kay-kim Nov 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Because the table can be quite wide. I took the docs artifacts into #34142 and:

  • tweaked the short code to below:
{{ range $.Site.Data.self_managed.materialize_crd_descriptions }}
#### {{ index . 0 }}
<table>
<thead>
<tr>
<th>Field Name</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
{{ range (index . 1) }}
<tr>
<td><code>{{ .name }}</code></td>
<td>{{ if .required }}✅{{ end }}</td>
<td><em>{{ .type }}</em>. {{ .description | markdownify }} {{ if .default
}}<br><br><strong>Default:</strong><code> {{ .default }}</code>{{ end }}</td>
</tr>
{{ end }}
</tbody>
</table>
{{ end }}

554 changes: 554 additions & 0 deletions schema_modified.json
View file
Open in desktop

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions src/cloud-resources/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,15 @@ publish = false
[lints]
workspace = true

[[bin]]
name = "crd-writer"
path = "src/bin/crd_writer.rs"

[dependencies]
anyhow = "1.0.100"
chrono = { version = "0.4.39", default-features = false }
futures = "0.3.31"
indexmap = { version = "2.10.0", default-features = false, features = ["std", "serde"] }
k8s-openapi = { version = "0.26.0", features = ["schemars", "v1_31"] }
kube = { version = "2.0.1", default-features = false, features = ["client", "derive", "openssl-tls", "ws", "runtime"] }
mz-ore = { path = "../ore", default-features = false, features = ["async"] }
Expand Down
Loading