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

Auto-generate helm values in README.md #207

Closed
wants to merge 2 commits into from
Closed

Conversation

danielhoherd
Copy link
Member

@danielhoherd danielhoherd commented Apr 2, 2021

This is a first crack at auto-generating the helm values in the README.md, as described briefly in #206. I'm not sure if this is a great idea, so I haven't finished this. I wanted to open this up to discussion before making any more progress.

One thing I'm not happy about is how the table contents are not rendered in an ascii readable way. I experimented with auto-formatting using prettier, but having both helm-docs and prettier modifying the file led to an always-fail scenario.

Another problem is that our values go so deep, the resulting table has horizontal scrolling that hides all but the left-most column. See https://github.com/astronomer/airflow-chart/blob/7384359163/README.md

@danielhoherd danielhoherd requested review from ashb and kaxil April 2, 2021 01:10
@kaxil
Copy link
Contributor

kaxil commented Apr 2, 2021

I like the approach, I pushed 5210691 to reduce the width (horizontal scrolling):

WDYT now @danielhoherd : https://github.com/astronomer/airflow-chart/blob/5210691162b5946d69c66362cd125868194d7654/README.md#values

@danielhoherd danielhoherd deleted the 206-helm-docs branch November 11, 2021 00:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants