Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Output docs for values that are commented out #175

Open
JakeSCahill opened this issue Mar 28, 2023 · 4 comments
Open

Output docs for values that are commented out #175

JakeSCahill opened this issue Mar 28, 2023 · 4 comments
Labels
enhancement New feature or request

Comments

@JakeSCahill
Copy link

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 Nepo26 added enhancement New feature or request question Further information is requested labels Jun 29, 2023
@Nepo26
Copy link
Collaborator

Nepo26 commented Jun 29, 2023

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

@JakeSCahill
Copy link
Author

JakeSCahill commented Jun 29, 2023

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

@Nepo26
Copy link
Collaborator

Nepo26 commented Jun 29, 2023

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?

@Nepo26 Nepo26 removed the question Further information is requested label Jun 29, 2023
@JakeSCahill
Copy link
Author

No worries, thanks!

Maybe you could parse for comments such as:

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: No status
Development

No branches or pull requests

2 participants