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 😬)