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]Support auto generate html page for pulsar client cli tool #10115

Conversation

tuteng
Copy link
Member

@tuteng tuteng commented Apr 1, 2021

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

  • Add auto script for pulsar-client
  • Add drop-menu for pulsar-client

(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

@tuteng tuteng changed the title Support auto generate html page for pulsar client cli tool [website][pulsar-client]Support auto generate html page for pulsar client cli tool Apr 1, 2021
@tuteng tuteng marked this pull request as draft April 1, 2021 11:19
@sijie sijie added this to the 2.8.0 milestone Apr 1, 2021
@sijie sijie added the area/tool label Apr 1, 2021
@codelipenghui codelipenghui modified the milestones: 2.8.0, 2.9.0 May 21, 2021
@urfreespace
Copy link
Member

i made a test and it's well, recommend merge it @tuteng

@tuteng tuteng marked this pull request as ready for review June 29, 2021 01:44
Signed-off-by: LiLi <urfreespace@gmail.com>
@tuteng
Copy link
Member Author

tuteng commented Jun 29, 2021

/pulsarbot rerun-failure-checks

@Anonymitaet Anonymitaet merged commit efbf9c1 into apache:master Jun 29, 2021
bharanic-dev pushed a commit to bharanic-dev/pulsar that referenced this pull request Mar 18, 2022
…ient cli tool (apache#10115)

* Support auto generate html page for pulsar client cli tool

* fix: document generation command no need to show in the generated docs

Signed-off-by: LiLi <urfreespace@gmail.com>

* fix: add pulsar-client doc auto generat in build-site.sh

Signed-off-by: LiLi <urfreespace@gmail.com>

Co-authored-by: LiLi <urfreespace@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants