[GitHub] [pulsar] momo-jun opened a new issue, #15771: [Doc] Auto-hide deprecated parameters in Pulsar admin CLI docs

[GitBox]

momo-jun opened a new issue, #15771:
URL: https://github.com/apache/pulsar/issues/15771

   ### What issue do you find in Pulsar docs?
   
   In Pulsar admin CLI docs, some commands have duplicate parameters. For 
example, processing guarantees have duplicate parameters as shown below:
   <img width="1134" alt="image" 
src="https://user-images.githubusercontent.com/60642177/170207999-52e629cb-6511-4f45-9001-1cd5f62e2114.png";>
   
   However, in the code file, we can tell that `--processingGuarantees` has 
been deprecated and this information is not demonstrated in docs which may 
confuse users.
   <img width="1163" alt="image" 
src="https://user-images.githubusercontent.com/60642177/170208585-879c508a-8fb1-419a-a042-11aac59af9e0.png";>
   
   
   ### What is your suggestion?
   
   Auto-hide deprecated parameters in Pulsar admin CLI docs by enhancing the 
auto-generation mechanism.
   
   ### Do you have any references?
   
   
https://pulsar.apache.org/tools/pulsar-admin/2.10.0-SNAPSHOT/#-em-localrun-em-
   
https://github.com/apache/pulsar/blob/branch-2.10/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdFunctions.java#L279-L280
   
   ### Would you like to fix this issue?
   
   Ping @urfreespace @tuteng 
   //cc @Anonymitaet 
   
   ### Note
   
   - [X] I have researched my question.


-- 
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.apache.org

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