Thanks yu, it seems to be a good start, so that we can better ensure the consistency of the code and documentation, rather than relying on artificial methods to fix the consistency problem.
Of course, I would be happy to participate if time permits. -- Thanks Xiaolong Ran Anonymitaet _ <anonymita...@hotmail.com> 于2021年7月7日周三 上午12:01写道： > Hi Pulsarers, > > > > With the rapid adoption of Pulsar, our community is providing many > features and enhancements for *Pulsar command-line tools* and *Pulsar > configuration*, that is great! > > > > Previously, the docs of them are updated *manually*, which is > time-consuming and error-prone. To improve the productivity, effectiveness, > and velocity of developing these contents, we are developing tools to > *generate docs from source code files automatically*. > > > > In this way, we can get the code and the doc to good enough quality on > both sides in parallel and then merge both together so they end up shipping > in the same release. > > > > Below is the comparison of before and after. Here takes the docs of > pulsar-client and pulsar-perf as examples. > > > > # pulsar-client > > - Previous: > https://pulsar.apache.org/docs/en/next/reference-cli-tools/#pulsar-client > > - Now: http://pulsar.apache.org/tools/pulsar-client/2.9.0-SNAPSHOT/ > > > > # pulsar-perf > > - Previous: > https://pulsar.apache.org/docs/en/next/reference-cli-tools/#pulsar-perf > > - Now: http://pulsar.apache.org/tools/pulsar-perf/2.9.0-SNAPSHOT/ > > > > Obviously, this is a huge project. So far, we have completed some tasks > and documented the progress and all details here: > https://docs.google.com/spreadsheets/d/1P6tePGmU1lEhGKY_hE3JWgJ1rUTBCmW7AshDICJZr3o/edit#gid=1030826289 > > > > Feel free to comment or CONTRIBUTE TOGETHER, we'd love your feedback here! > > > > P.S. Special thanks goes to tuteng, urfreespace, and 315157973 for making > this happen! > > > > Anonymitaet > > > > >
