feat: support section description through user-defined templates

[pkoutsovasilis]

This PR is a PoC of how user-defined templates could be incorporated to support writing a description between the Section header and values table.

An example of this can be found here

• Relates [Feat]: Add markdown description to Sections #227

[norwoodj]

Hello, sorry for the slow response. I like the idea here, but why do the descriptions need to be templates? It seems unnecessarily complex. I would merge a PR which allowed you to simply specify, for instance:

# -- This is some value
# @section -- Section 1
# @sectionDescription -- This is a description for the first section

I'm not convinced that this is any worse or limiting than allowing users to specify templates, and I think it's much easier for users to understand.

[pkoutsovasilis]

Hello, sorry for the slow response. I like the idea here, but why do the descriptions need to be templates? It seems unnecessarily complex. I would merge a PR which allowed you to simply specify, for instance:

# -- This is some value
# @section -- Section 1
# @sectionDescription -- This is a description for the first section

I'm not convinced that this is any worse or limiting than allowing users to specify templates, and I think it's much easier for users to understand.

Hi 👋 the only small reason I have against your proposal is that at the end of the day the crucial bit of a values.yaml for someone is being able to read and write the actual values. To this end, I always find it kinda tricky to have the right amount of meta comments that do not hinder the aforementioned. Thus to me a description of the section feels better handled by the user in their template.

However, I can give your proposal a try and see what this looks like 🙂

[wrenix]

How to create a Section 1-Values template (without redefine the Table template)?