✨ (helm/v2-alpha): Improve generated values.yaml comment conventions (single # vs ##)

[camilamacedo86]

Update values.yaml generation to use ## for section headers and documentation blocks, following Helm chart best practices.

[vitorfloriano]

Hi @camilamacedo86 could you explain the reasoning behind this change? I was trying to find something about using double hashtags in the official docs but couldn't.

For what I was able to learn this is mostly a formatting for readme-generation tools used in the industry. Right?

[camilamacedo86]

Thanks for asking!

This isn’t a Helm/YAML “requirement” (so you won’t find it mandated in the Helm docs), it’s mainly a usability convention for values.yaml files.

In values.yaml we have two different kinds of commented lines:

1. Commented-out values users may want to enable
   These use a single #, so if someone removes that # (manually or via an editor “uncomment selection” shortcut) the line becomes valid YAML, e.g.:

• # fullnameOverride: ""

2. Pure documentation / section headers / prose
   These should never become YAML keys/values. If they were # Arguments, and someone bulk-uncomments a block, that line would become Arguments (invalid YAML) and could break helm install -f values.yaml since values files are plain YAML.

So we use ## for those docs/headers (and keep separator lines as ##/## ...) so that a “remove one leading #” operation still leaves them commented (# ...) and the file stays valid. This is exactly what the change is doing in this PR (e.g. # Arguments → ## Arguments).

This convention is also pretty common in the ecosystem (for example, the prometheus-community chart uses lots of ## doc lines and single-# commented examples).

[camilamacedo86]

I updated the title to better clarify.

[vitorfloriano]

Got it. Thanks!

[vitorfloriano]

/lgtm

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, vitorfloriano

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [camilamacedo86]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment