Create example datum_gateway_config.json #50
Conversation
Created complete example datum_gateway_config.json using the defaults documented in datum_gateway --help as much as possible.
|
Should the example have fields that normally would be omitted? |
|
My rationale was that it would provide a complete starting point for someone who wanted to customize, with defaults documented. (Would have commented out the ones that are at defaults, but no way I know of in JSON.) |
|
While examples are nice, I'm not sure we want to have to always update the example any time something is tweaked with the conf mechanisms... I wonder if it'd make more sense to modify datum_conf.c to be able to just generate an example config by giving a command line option... similar to how it does --help ... this way it's always up to date, and can specify if you want to a full example with all defaults or just required fields, too. Something like --example-conf and --example-conf-full that for options that just spit out the example and exit. Should be pretty trivial to generate. |
|
Seems like --help is already almost there; just don't include the comments for --example-conf-full? |
Update to reflect new minimum value per OCEAN-xyz#51
This comment was marked as off-topic.
This comment was marked as off-topic.
|
How about #87? |
Created complete example datum_gateway_config.json using the defaults documented in datum_gateway --help as much as possible. Also creates /share/examples path for it.