Hey folks ! I see some configuration values that a...
# contribute-code
d
Hey folks ! I see some configuration values that are not mentioned in any docs in anywhere. One example is this one. This requires more documentation to explain why it is a thing that is overridable, what it causes etc. There are many extra env vars you could pass to the containers but only way to find these is looking to the code. So improving their visibility and adding some explanation to them would be a good improvement point IMO. My question is, where do you think we should put some docs for the variables that are not directly defined on helm templates(=passed to containers through extra envs)?
m
Hey Mert, great callout. I think it would be ideal if we had a way to declare documentation on the config model directly and the env variables and documentation about it was driven off of that.
If you have seen other projects doing this well, do send some pointers over and we'll see if we can incorporate those techniques into datahub
d
I have only seen documentation as comments in the application.properties/yaml file before, which is not the ideal case considering the need here I guess(wouldn't it be better if these pop up in https://datahubproject.io/ too, I'm not sure) With a very brief search online, I found nothing too 😄 Unfortunately I don't have any suggestion but I can say ideally: • People using helm may somehow encounter these extra configurations and take a look at them. Maybe these docs and live together with the dockerfiles. • Search on the docs on the Datahub's website should find them. • These should stay close to the properties file, or the config classes inside the code if somebody wants to reach the docs from the code itself. (I have 0 confidence on what I say, it is your call 😬)