Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[website][pulsar-client/pulsar-perf] pulsar-client and pulsar-perf cli doc command flag duplicated #11182

Merged

Conversation

urfreespace
Copy link
Member

Master Issue: #10040

Motivation

Support auto generate HTML page for pulsar client cli tool, for example: https://github.com/apache/pulsar/tree/asf-site/content/tools/pulsar-admin

Modifications

fix duplicated long and short command line parameter names for pulsar-client cli docs
fix duplicated long and short command line parameter names for pulsar-perf cli docs

(Please pick either of the following options)

This change is a trivial rework / code cleanup without any test coverage.

(or)

This change is already covered by existing tests, such as (please describe tests).

(or)

This change added tests and can be verified as follows:

(example:)

Added integration tests for end-to-end deployment with large payloads (10MB)
Extended integration test for recovery after broker failure

Does this pull request potentially affect one of the following parts:

If yes was chosen, please highlight the changes

Dependencies (does it add or upgrade a dependency): (yes / no)
The public API: (yes / no)
The schema: (yes / no / don't know)
The default values of configurations: (yes / no)
The wire protocol: (yes / no)
The rest endpoints: (yes / no)
The admin cli options: (yes / no)
Anything that affects deployment: (yes / no / don't know)

Documentation

Does this pull request introduce a new feature? (yes / no)
If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)
If a feature is not applicable for documentation, explain why?
If a feature is not documented yet in this PR, please create a followup issue for adding the documentation

Signed-off-by: LiLi <urfreespace@gmail.com>
@urfreespace
Copy link
Member Author

@Anonymitaet @tuteng PTAL, thanks

@tuteng tuteng requested review from 315157973 and tuteng July 1, 2021 11:53
@tuteng tuteng added area/client type/bug The PR fixed a bug or issue reported a bug component/website labels Jul 1, 2021
@tuteng tuteng requested a review from Anonymitaet July 1, 2021 11:55
Copy link
Member

@tuteng tuteng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tuteng
Copy link
Member

tuteng commented Jul 2, 2021

/pulsarbot rerun-failure-checks

@Anonymitaet
Copy link
Member

@urfreespace thanks for your contribution!

@Anonymitaet
Copy link
Member

/pulsarbot rerun-failure-checks

@tuteng
Copy link
Member

tuteng commented Jul 2, 2021

@315157973 PTAL

@Anonymitaet
Copy link
Member

/pulsarbot rerun-failure-checks

@Anonymitaet Anonymitaet added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Jul 2, 2021
@tuteng
Copy link
Member

tuteng commented Jul 2, 2021

Unrelated test failures

Error:  testTokenProducerAndConsumer(org.apache.pulsar.client.api.TokenAuthenticatedProducerConsumerTest)  Time elapsed: 0.144 s  <<< FAILURE!
org.apache.pulsar.client.admin.PulsarAdminException$NotAuthorizedException: HTTP 401 Unauthorized
	at org.apache.pulsar.client.admin.internal.BaseResource.getApiException(BaseResource.java:228)
	at org.apache.pulsar.client.admin.internal.BaseResource$1.failed(BaseResource.java:130)
	at org.glassfish.jersey.client.JerseyInvocation$1.failed(JerseyInvocation.java:882)
	at org.glassfish.jersey.client.JerseyInvocation$1.completed(JerseyInvocation.java:863)

@tuteng
Copy link
Member

tuteng commented Jul 2, 2021

/pulsarbot rerun-failure-checks

1 similar comment
@tuteng
Copy link
Member

tuteng commented Jul 3, 2021

/pulsarbot rerun-failure-checks

@urfreespace
Copy link
Member Author

image
@tuteng Was automatically cancelled due to timeout?

@tuteng
Copy link
Member

tuteng commented Jul 7, 2021

/pulsarbot rerun-failure-checks

@tuteng
Copy link
Member

tuteng commented Jul 7, 2021

image
@tuteng Was automatically cancelled due to timeout?

Because the test run time exceeds 60 minutes

@tuteng tuteng added this to the 2.9.0 milestone Jul 7, 2021
@tuteng tuteng merged commit 4cbae56 into apache:master Jul 7, 2021
bharanic-dev pushed a commit to bharanic-dev/pulsar that referenced this pull request Mar 18, 2022
…pache#11182)

### Master Issue: apache#10040

### Motivation
Support auto generate HTML page for pulsar client cli tool, for example: https://github.com/apache/pulsar/tree/asf-site/content/tools/pulsar-admin

### Modifications
fix duplicated long and short command line parameter names for pulsar-client cli docs
fix duplicated long and short command line parameter names for pulsar-perf cli docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/client doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. type/bug The PR fixed a bug or issue reported a bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants