search

apache / pulsar

Apache Pulsar - distributed pub-sub messaging system
https://pulsar.apache.org/
Apache License 2.0
14.19k stars 3.58k forks source link

[Doc] inaccurate docs on Reference Page #18682

Open Anonymitaet opened 1 year ago

Anonymitaet commented 1 year ago

Search before asking

What issue do you find in Pulsar docs?

Currently, client conf doc is inaccurate. The content should be the same as in https://github.com/apache/pulsar/blob/master/conf/client.conf.

What is your suggestion?

The client conf doc is generated automatically from https://github.com/apache/pulsar/blob/master/pulsar-client/src/main/java/org/apache/pulsar/client/impl/conf/ClientConfigurationData.java, while @hangc0276 suggests that it should be generated from https://github.com/apache/pulsar/blob/master/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/PulsarAdminTool.java.

  1. Would anyone like to dig into and fix this issue? Thank you!

  2. We might need to copy this chapter to the Pulsar configuration guide on the NEXT branch before fixing this issue.

    image

cc @momo-jun @DaveDuggins @D-2-Ed

Any reference?

N/A

Are you willing to submit a PR?

Anonymitaet commented 1 year ago

A new issue of pulsar-admin was found on the Reference page.

The default values are incorrect, but we (@tjiuming) have no idea how to update these values in the code file. What's the process of generating pulsar-admin docs automatically and how it gets the default values?

image

So we update the .md file first (https://github.com/apache/pulsar/pull/19001)

cc @hangc0276

github-actions[bot] commented 1 year ago

The issue had no activity for 30 days, mark with Stale label.