Support for lists

[robertgates55]

Thanks for this - really nice.

Got really excited and migrated to this format throughout, and then found that it doesn't look to handle list objects?

Some of the main values blocks in our helm chart look like:

tenants:
  # Some desc
- name: tenant_name
  features:
    # Some other desc
    bob: foo

Which you often see documented like:

Parameter	Description
tenants[0].name	Some desc
tenants[0].features.bob	Some other desc

Is this possible? Is this easily implemented if not?

[tamalsaha]

You are right that lists are not handled. I did not handle it because it is not clear to me how to handle that in the docs. In your example, if here are multiple array elements how does it show up in the doc?

[robertgates55]

I think just displaying the index inside square brackets seems to be closest to a standard that I’ve seen - tenants[0], tenants[1] etc - and then leaving it up to users to annotate the different elements accordingly?

[robertgates55]

Reread your question:

tenants:
  # Some desc
- name: tenant_name
  features:
    # A feature
  - name: bob
    # Some other desc
    bob: foo

Would get you:
tenants[0].features[0].name

And I think for clarity you’d maybe only ever display the 0th indexed element of any list - comments on eg the second index would be ignored?

[tamalsaha]

I see that you want to document the structure of the list type values field. If you want to do so, you need to make changes to https://github.com/kubepack/chart-doc-gen/blob/master/walk/associative_sequence.go#L15 file. I am open to prs.

[norwoodj]

@robertgates55 my tool helm-docs supports lists in the way you describe already. Why not give it a try?

@tamalsaha I wonder if you've seen this project. Seems to do basically the same thing you're attempting here but has been around a couple years so has many more features.