Tsz-wo Sze created RATIS-2107:
---------------------------------
Summary: Generate conf md doc
Key: RATIS-2107
URL: https://issues.apache.org/jira/browse/RATIS-2107
Project: Ratis
Issue Type: Sub-task
Components: documentation, util
Reporter: Tsz-wo Sze
The ConfUtils.printAll(Class) can print the conf details. For example, if we
run RaftClientConfigKeys, it will print out the following:
{code}
******* interface org.apache.ratis.client.RaftClientConfigKeys *******
constant: PREFIX = raft.client
******* interface org.apache.ratis.client.RaftClientConfigKeys$MessageStream
*******
constant: PREFIX = raft.client.message-stream
key: raft.client.message-stream.submessage-size
(org.apache.ratis.util.SizeInBytes, default=1MB (=1048576))
...
{code}
In this JIRA, we suggest to
- add description for the conf key
- support a mode to print out in [md
format|https://github.com/apache/ratis/blob/master/ratis-docs/src/site/markdown/configurations.md?plain=1]
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
