search

EventStore / documentation

Next-gen documentation website
https://developers.eventstore.com/
10 stars 17 forks source link

Consider fully documenting the configuration options #675

Open rmfaheem opened 3 months ago

rmfaheem commented 3 months ago

Most config options are well documented, for example those relating to the network config, thread counts, etc...

Some are not well documented. It would be cool to have a complete documentation on all the config options, their purpose and expected/allowed values.

coloradomorrissey commented 3 months ago

Faheem - is there a complete list of configurations that should be documented?

rmfaheem commented 3 months ago

Actually, I've just noticed that we already added the undocumented configs on the 24.6 release branch. You can see all of them here.

That is basically what I was referring to. You can see that those configs are not explained all in the documentation of the other releases.

I somehow missed that we added it to the 24.6 docs. I guess we'll need to just cherry pick the PR which introduced that section of the docs to the other release branches, or at least that of 23.10 (because that one will be supported till the end of next year).