younsl commented on PR #205:
URL:
https://github.com/apache/superset-kubernetes-operator/pull/205#issuecomment-5040441843
`helm-docs` supports an optional type hint in the annotation: `# -- (type)
description`. Adding it gives two concrete wins for this chart:
**A. Correct `Type` column for empty/placeholder defaults.** Fields like
`image.tag`, `serviceAccount.name`, `metrics.certSecretName` default to `""`,
and `nodeSelector`/`affinity` to `{}`. Auto-inference works for scalars but is
fragile once a placeholder is meant to hold a structured value. Pinning the
type documents intent:
```yaml
serviceAccount:
# -- (string) Name of the ServiceAccount to use. Auto-generated from
release name when empty.
name: ""
# -- (object) Annotations to add to the ServiceAccount.
annotations: {}
```
**B. Keep the README table readable for large objects.** Without a hint,
`resources`, `healthProbes.*`, `podSecurityContext`, and `securityContext` dump
their full multi-line YAML into a single table cell. Pair `(object)` with
`@default` to collapse it to a link:
```yaml
# -- (object) Compute resource requests and limits for the manager container.
# @default -- See [values.yaml](./values.yaml)
resources:
limits:
cpu: 500m
memory: 512Mi
requests:
cpu: 10m
memory: 64Mi
```
This renders as a clean `object | See values.yaml` row instead of an inlined
YAML blob, which also improves the ArtifactHub display.
If you'd prefer to keep this PR focused, I'm happy to send a follow-up PR
that adds the `(type)` hints across the remaining fields once this one lands.
Just let me know which you'd rather do.
--
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]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
