jojochuang opened a new pull request, #8588:
URL: https://github.com/apache/ozone/pull/8588

   ## What changes were proposed in this pull request?
   HDDS-13211. [Docs] Add a reference page for Ozone Client Configuration 
Properties
   
   Please describe your PR in detail:
   * Generated-by: Copilot Agent (Preview), prompts
   
   ```
   List all configuration properties in OzoneClientConfig class. The full name 
of a configuration is the prefix + key.
   
   Add a doc for these properties. It's going to be a standalone new doc under 
hadoop-hdds/docs/content/interface, called Configurations.md It will have a 
Hugo compatible header, an Apache license text, title will be "Client 
Configurations"
   Generate a table of the configurations, their property name, default value 
and descriptions.
   
   After the first paragraph, mention that The configuration properties are 
generated from Configuration class OzoneClientConfig.
   
   Add the configuration properties from OMClientConfig class, into a second 
table.
   
   Repeat, for XceiverClientManager class.
   
   Repeat for ScmClientConfig class.
   
   Repeat for RatisClientConfig and RaftConfig.
   ```
   
   Double checked using the following prompt:
   ```
   Check the properties, make sure the default values and descriptions are 
correct. Use source code as source of truth.
   ```
   
   Eye-balled the result to fix minor issues and verify.
   
   Note: the standalone org.apache.hadoop.hdds.scm.proxy.SCMClientConfig is 
used by OM and DataNode, it's not a client configuration, unlike the 
ScmClientConfig class in XceiverClientManager.
   
   ## What is the link to the Apache JIRA
   
   https://issues.apache.org/jira/browse/HDDS-13211
   
   ## How was this patch tested?
   
   User doc. Double checked the source code.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to