[GitHub] [pulsar] Anonymitaet commented on a diff in pull request #16627: [feature][doc] Generate config docs from source code

[GitBox]

Anonymitaet commented on code in PR #16627:
URL: https://github.com/apache/pulsar/pull/16627#discussion_r925727981


##########
site2/docs/reference-configuration-bookkeeper.md:
##########
@@ -0,0 +1,585 @@
+# BookKeeper
+
+BookKeeper is a replicated log storage system that Pulsar uses for durable 
storage of all messages.
+
+## Optional

Review Comment:
   @gaoran10 are the configurations of `BookKeeper, client, log4j, log4j shell, 
standalone, ZooKeeper` all optional?



##########
site2/docs/reference-configuration-broker.md:
##########
@@ -0,0 +1,3879 @@
+# Broker
+## Required
+### clusterName
+Name of the cluster to which this broker belongs to
+
+**Default**: `null`
+
+**Dynamic**: `false`
+
+**Category**: Server
+
+## Optional
+### acknowledgmentAtBatchIndexLevelEnabled
+Whether to enable the acknowledge of batch local index
+

Review Comment:
   @gaoran10 is this correct?
   <img width="569" alt="image" 
src="https://user-images.githubusercontent.com/50226895/180017827-95e7a9df-2d13-4180-b5e4-ba89e2e00759.png";>
   



##########
site2/docs/reference-configuration-pulsar-proxy.md:
##########
@@ -0,0 +1,934 @@
+# Pulsar proxy
+## Required

Review Comment:
   If there is no `required` configuration, can you add an explanation? 
Something like `All configurations for Pulsar proxy are optional`?



##########
site2/docs/reference-configuration-websocket.md:
##########
@@ -0,0 +1,495 @@
+# WebSocket
+## Required
+### clusterName
+Name of the cluster to which this broker belongs to
+
+**Default**: `null`
+
+**Dynamic**: `false`
+
+**Category**: 

Review Comment:
   If all configurations do not have category values and will not have in the 
future, consider not showing `category` because it does not provide useful info 
to users?



##########
site2/docs/reference-configuration-standalone.md:
##########
@@ -0,0 +1,1465 @@
+# Standalone
+
+## Optional
+
+### authenticateOriginalAuthData
+
+If this flag is set to `true`, the broker authenticates the original Auth 
data; else it just accepts the originalPrincipal and authorizes it (if 
required).
+
+**Default**: false
+
+### metadataStoreUrl
+
+The quorum connection string for local metadata store
+
+**Default**:

Review Comment:
   Why no value? If it does not have a default value, can you add an 
explanation? Something like `it does not have a default value`?



-- 
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: commits-unsubscr...@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org