+1, I think it is a good idea. Would be nice to make sure these improvements propagate into the docs on the website.
On Sun, Oct 8, 2023 at 5:57 AM steven lu <lushiji2...@gmail.com> wrote: > we will improve the description of 47 commands for bin/bookkeeper with > BP-64 > https://github.com/apache/bookkeeper/issues/4101 > > # Motivation > > When executing the command `./bin/bookkeeper shell`, the usage description > of each command is not precise enough, > - some commands have no description; > - if there are descriptions, the explanation of the parameters is not clear > > so it is difficult for us to understand and use each command. we need to > combine the code to understand it, then it takes unnecessary time. > > Related screenshot information: > > https://github.com/apache/bookkeeper/assets/42990025/578d0d2f-b443-4f2d-a8f5-d7b3fd1c70c1 > <img width="1424" alt="image" src=" > > https://github.com/apache/bookkeeper/assets/42990025/578d0d2f-b443-4f2d-a8f5-d7b3fd1c70c1 > "> > > > # Proposal > > 1) I plan to improve this function. The first version only involves the > optimization of the getUsage method of these 47 commands from > `org.apache.bookkeeper.bookie.BookieShell` > 2) Use this as the bookkeeper specification. You will also need to follow > this specification when adding new command codes later. > -- Andrey Yegorov
