-
Notifications
You must be signed in to change notification settings - Fork 138
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
Document all values/defaults in func.yaml #1841
Comments
/kind documentation |
We do currently have a document for |
Sometimes this conundrum is solved by writing a fully-populated, but commented-out config file to disk, which has all (commented) values set to their defaults at time of installation. We can not fully replicate the workflow due to the choice of yaml as our config file format, but, we could potentially get most of the benefit by prepending this fully-populated config as a generated header to func.yaml on save. The header config comment block would not inhibit the parsing of the config, and we would be free to add as much exposition as is necessary for each setting, while not falling into the pitfalls of a pre-populated config. This also has an interesting potential benefit of allowing us to re-generate this docs header as the system is updated so it stays current. |
We can also write the |
This issue is stale because it has been open for 90 days with no |
There should be a section for each runtime which documents all possible configuration options and used defaults.
Without this, user cannot easily find out what defaults are applied to their application (for example definition of health checks for a Quarkus runtime).
The text was updated successfully, but these errors were encountered: