On Mon, 4 Mar 2019 at 21:36, Gian Merlino <[email protected]> wrote: > I'm a bit scared that doing this would make the already large list of > configuration options ( > http://druid.io/docs/latest/configuration/index.html) > become even more daunting and difficult to wrap one's head around. >
Sounds like a good nudge for ourselves to always seek for opportunities to remove configurations! Besides, we may reorganize the page to show only configuration names, and then a full description is open (like a "spoiler" but not exactly, I'm not sure how this HTML control is called. Similar to how FAQ lists are organized sometimes) when the option name is clicked. Markdown->HTML converter that we use may support this, so the doc may need to become a proper HTML page. Since, so often, multiple parameters interact with each other, maybe it > would make sense for the larger explanatory texts to be written in their > own sections, with the parameter tables linking to them? It makes sense > with processing buffer size and num threads configs, for example, since > they aren't just important alone but they do relate to each other as well. > I'm afraid the necessity to find a place for a section, inner feeling that a section should be "big enough" to justify its existence, the necessity of inter-linking in markdown will make it even less likely in practice that developers will create good docs with comprehensive discussions of configuration options and their values.
