You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/07/22 04:01:32 UTC

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

Anonymitaet commented on PR #16627:
URL: https://github.com/apache/pulsar/pull/16627#issuecomment-1192155095

   As we discussed just now:
   
   🔹🔹🔹🔹🔹🔹
   
   For Pulsar components (broker, websocket, proxy, client, standalone):
   - Categorize them as `Required`, `Optional`, `Deprecated`
   - Show all properties no matter if it has a value. 
   - Add a `note` to the beginning of each doc. Something like:
   > This page is automatically generated from code files. If you find something inaccurate, feel free to update [configuration-file-name-placeholder](URL-placeholder). Do not edit this markdown file manually. Manual changes will be overridden by each automatic generation.
   
   
   🔹🔹🔹🔹🔹🔹
   
   For non-Pulsar components (BK, log4j, log4jshell, ZK)
   - Do not categorize them as `Required`, `Optional`, `Deprecated`. It's hard to define them since docs are generated from external files


-- 
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-unsubscribe@pulsar.apache.org

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