norwoodj/helm-docs

Output docs for values that are commented out

JakeSCahill opened this issue · 4 comments

JakeSCahill commented

How do I get this tool to output values that are commented out? For example:

# -- To use a custom pre-installed Issuer, add its name and kind here.
# issuerRef:
#   name: redpanda-default-root-issuer
#   kind: Issuer   # Can be Issuer or ClusterIssuer
Nepo26 commented

Do you want to make it output the values as if they are not commented out? Not sure if it's currently possible.

JakeSCahill commented

Ideally, yes. If it’s not currently possible, it’d be great to add this as a feature request

Nepo26 commented

I will add it as a feature request.

Sorry for the late reply. The repo was abandoned and we're getting it on track again right now.

How do you propose that we do it? As there is need for some people to include the commented out code as description for other parts. Maybe some flag or categorize it as disabled or deprecated?

JakeSCahill commented

No worries, thanks!

Maybe you could parse for comments such as:

# @include
# --description of the commented value
# some-commented-key: value
  • 👍2