[RATIS-2107] Generate conf md doc

• Type: Sub-task
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: documentation, util
• Assignee: Unassigned
• Reporter: Tsz-wo Sze
• Created: 04/Jun/24 09:30
• Updated: 04/Jun/24 09:31

Description

The ConfUtils.printAll(Class) can print the conf details. For example, if we run RaftClientConfigKeys, it will print out the following:

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

...  

In this JIRA, we suggest to

• add description for the conf key
• support a mode to print out in md format

Issue Links

• relates to: RATIS-1732 Add configuration reference for RaftServer
• relates to: RATIS-2106 Add configuration reference for RaftClient