Consolidation of config param documentation #2787
ancazamfir
started this conversation in
General
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
[Summary of TODOs from @cason after the sync review with @sergio-mena]
Given the new Configuration user manual, what content should we maintain as comments (description for parameters) in the
config.toml
file?The main issue here: how to keep the user manual and comments in the config file synchronized?
Note: we even have a third documentation of config flags which are the comments (Go doc) in
config/config.go
:// Note: any changes to the comments/variables/mapstructure
// must be reflected in the appropriate struct in config/config.go.
cc also @andynog @greg-szabo , please summarize your thoughts here
Beta Was this translation helpful? Give feedback.
All reactions