apache/pulsar

[Doc] controlled-failover Optimize example code

Open

#23,512 opened on Oct 24, 2024

View on GitHub
 (1 comment) (0 reactions) (1 assignee)Java (13,697 stars) (3,485 forks)batch import
doc-requiredgood first issue

Description

Search before asking

  • I searched in the issues and found nothing similar.

What issue do you find in Pulsar docs?

https://pulsar.apache.org/docs/3.0.x/client-libraries-cluster-level-failover/#controlled-failover There is unnecessary code present image image

because org.apache.pulsar.client.impl.ClientBuilderImpl#build already initialize image

What is your suggestion?

delete provider.initialize(pulsarClient); image

Any reference?

No response

Are you willing to submit a PR?

  • I'm willing to submit a PR!

Contributor guide

Tech stack
java
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue is to remove the unnecessary `provider.initialize(pulsarClient);` call from the example code in the controlled failover documentation. The example is on the page https://pulsar.apache.org/docs/3.0.x/client libraries cluster level failover/#controlled failover. The fix is a single line deletion. No additional research needed.