apache / apache/pulsar

[Doc] inaccurate docs on Reference Page

Open
#18,682 2 comments 0 reactions 0 assignees View on GitHub
doc Stale
Dominant language
Java
Stars
15.3k
Forks
3.8k
Avg merge
1d 14h
Merged PRs (30d)
160

Description

### Search before asking

- [X] I searched in the [issues](https://github.com/apache/pulsar/issues) and found nothing similar.

### What issue do you find in Pulsar docs?

Currently, [client conf doc](https://pulsar.apache.org/reference/#/next/config/reference-configuration-client) 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](https://pulsar.apache.org/reference/#/next/config/reference-configuration-client) 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?

- [ ] I'm willing to submit a PR!

Contributor guide

Open the contributing guide

Research direction

Compare the generated client configuration reference with conf/client.conf, then inspect ClientConfigurationData.java and PulsarAdminTool.java to understand the current source and generation path. Check whether the chapter must first be copied to the NEXT Pulsar configuration guide. Done means the generated client configuration documentation matches conf/client.conf and the relevant guide is updated.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.