[GitHub] [pulsar] yuruguo commented on pull request #11980: [doc] Update cli-tools document

[GitBox <gi...@apache.org>]

yuruguo commented on pull request #11980:
URL: https://github.com/apache/pulsar/pull/11980#issuecomment-917537006


   > Currently, after pulsar 2.8, most of the tools' documentation is automatically generated by the tool, and only a few of them are not yet covered by the automation tool, so my suggestion is to remove them from this documentation and add a link https://pulsar.apache.org/tools/pulsar-perf/2.9.0-SNAPSHOT/ to them for those already generated by the tool, such as pulsar-perf, etc. This will save us a lot of work, and the documentation will be correct will also be improved. @Anonymitaet @yuruguo
   
   Thanks  for your reply @tuteng .
   It is a very profitable thing to generate tools' documents through automated tools and provide special links. I found that `pulsar-admin` has been maintained in this way [since version `2.6`](https://pulsar.apache.org/tools/pulsar-admin/). But I have a few questions to confirm:
   Do these cli-tools like `pulsar-client`, `pulsar-perf` and `pulsar` also use same method only from version `2.9`?
   If yes, do we still need to manually update the previous version such as `2.8.x`, `2.7.x` or even earlier (ps: It‘s very important to maintain the consistency of the documentation, because from my experience in using pulsar, I started with the official documentation and core tools )? I am willing to continue to do this work and have manually updated part of the previous version(including `2.8.2`, `2.8.1`, `2.8.0`, `2.7.3`, `2.7.2`, `2.7.1` and `2.7.0`) although I haven't pushed it yet @tuteng @Anonymitaet .
   If not, we may not need to manually update the relevant documents of the previous version, then this pr may be closed.


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