Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
document more config options #25456
Good point. Thanks for adding these missing help texts? What's the reasoning behind changing the capital letters at the beginning of each help text to lowercase? This makes the help text look a bit odd in the Dashboard UI. For consistency, I'd suggest to always start a help text with a capital letter.
I was trying to be consistent with other options, although it is admittedly a mix. My thinking is that while long_description should be complete sentences and thus capitalized, the short description should be a noun phrase/expression/whatever the right grammatical term is... and generally not a complete sentence.
3 times, most recently
Dec 11, 2018
I'm sorry for the late question, but I saw some config options e.g. https://github.com/ceph/ceph/blob/master/src/common/options.cc#L507 "tagged" with service "common" or "rgw" although http://docs.ceph.com/docs/master/rados/configuration/ceph-conf/#configuration-sections says the possible sections are "global", "mon", "mgr", "osd", "mds" and "client".
Ah, okay, thanks for the clarification!
Would there be another way to figure out which section applies to a config option? - I think it would be a great improvement if we could filter the relevant sections in the config options editor (dashboard). We're showing all sections for every config option at the moment and the user can set the value for a section even if it doesn't belong to the config option.