Skip to content

[docs] Update docs for topic stats in admin apis.#10868

Merged
Anonymitaet merged 19 commits intoapache:masterfrom
Jason918:udpate_topic_stats_docs
Jul 9, 2021
Merged

[docs] Update docs for topic stats in admin apis.#10868
Anonymitaet merged 19 commits intoapache:masterfrom
Jason918:udpate_topic_stats_docs

Conversation

@Jason918
Copy link
Contributor

@Jason918 Jason918 commented Jun 9, 2021

Motivation

There are a lot new variables which are not explained in docs when we get topic stats data using the cmd bin/pulsar-admin topics stats <topic>.
This PR is trying to sync the docs with the source code.

Modifications

The new docs mostly come from comment in source code.

Verifying this change

  • Make sure that the change passes the CI checks.

Only doc is updated.

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): (no)
  • The public API: ( no)
  • The schema: ( no )
  • The default values of configurations: (no)
  • The wire protocol: ( no)
  • The rest endpoints: ( no)
  • The admin cli options: (no)
  • Anything that affects deployment: (no )

Documentation

  • Does this pull request introduce a new feature? ( 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

@Jason918
Copy link
Contributor Author

Jason918 commented Jun 9, 2021

@Anonymitaet Hi, can you please take a look?

Anonymitaet
Anonymitaet reviewed Jun 10, 2021
View reviewed changes
Anonymitaet
Anonymitaet reviewed Jun 10, 2021
View reviewed changes
Anonymitaet
Anonymitaet reviewed Jun 10, 2021
View reviewed changes
Anonymitaet
Anonymitaet reviewed Jun 10, 2021
View reviewed changes
Anonymitaet
Anonymitaet reviewed Jun 10, 2021
View reviewed changes
Anonymitaet
Anonymitaet reviewed Jun 10, 2021
View reviewed changes
Anonymitaet
Anonymitaet reviewed Jun 10, 2021
View reviewed changes
Anonymitaet
Anonymitaet reviewed Jun 10, 2021
View reviewed changes
Anonymitaet
Anonymitaet reviewed Jun 10, 2021
View reviewed changes
Anonymitaet
Anonymitaet reviewed Jun 10, 2021
View reviewed changes
Anonymitaet
Anonymitaet reviewed Jun 10, 2021
View reviewed changes
Anonymitaet
Anonymitaet reviewed Jun 10, 2021
View reviewed changes
Anonymitaet
Anonymitaet reviewed Jun 10, 2021
View reviewed changes
Anonymitaet
Anonymitaet reviewed Jun 10, 2021
View reviewed changes
Copy link
Member

@Anonymitaet Anonymitaet left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution. I’ve left some comments, PTAL.

@Anonymitaet Anonymitaet added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Jun 10, 2021
Jason918 and others added 13 commits June 10, 2021 10:19
@Jason918 @Anonymitaet
Update site2/docs/admin-api-topics.md
4429e29 
Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>
@Jason918 @Anonymitaet
Update site2/docs/admin-api-topics.md
c862048 
Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>
@Jason918 @Anonymitaet
Update site2/docs/admin-api-topics.md
fb1d18d 
Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>
@Jason918 @Anonymitaet
Update site2/docs/admin-api-topics.md
b89c7e2 
Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>
@Jason918 @Anonymitaet
Update site2/docs/admin-api-topics.md
7b600b6 
Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>
@Jason918 @Anonymitaet
Update site2/docs/admin-api-topics.md
a9dfff3 
Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>
@Jason918 @Anonymitaet
Update site2/docs/admin-api-topics.md
0e67b08 
Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>
@Jason918 @Anonymitaet
Update site2/docs/admin-api-topics.md
d1c46b5 
Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>
@Jason918 @Anonymitaet
Update site2/docs/admin-api-topics.md
62e767d 
Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>
@Jason918 @Anonymitaet
Update site2/docs/admin-api-topics.md
ff982df 
Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>
@Jason918 @Anonymitaet
Update site2/docs/admin-api-topics.md
6c0e88c 
Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>
@Jason918 @Anonymitaet
Update site2/docs/admin-api-topics.md
fc5a0fd 
Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>
@Jason918 @Anonymitaet
Update site2/docs/admin-api-topics.md
1a32148 
Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>
@Jason918
Copy link
Contributor Author

Jason918 commented Jun 10, 2021

Thanks for your contribution. I’ve left some comments, PTAL.

@Anonymitaet Thx, all the comments are resolved, PTAL.

michaeljmarshall
michaeljmarshall reviewed Jun 15, 2021
View reviewed changes
Copy link
Member

@michaeljmarshall michaeljmarshall left a comment

Choose a reason for hiding this comment

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

Left some minor comments. This is a great addition.

Jason918 and others added 5 commits June 16, 2021 15:28
@Jason918 @michaeljmarshall
Update site2/docs/admin-api-topics.md
e7158e1 
Co-authored-by: Michael Marshall <mikemarsh17@gmail.com>
@Jason918 @michaeljmarshall
Update site2/docs/admin-api-topics.md
8e0ba27 
Co-authored-by: Michael Marshall <mikemarsh17@gmail.com>
@Jason918 @michaeljmarshall
Update site2/docs/admin-api-topics.md
3922b5c 
Co-authored-by: Michael Marshall <mikemarsh17@gmail.com>
@Jason918 @michaeljmarshall
Update site2/docs/admin-api-topics.md
93ef33a 
Co-authored-by: Michael Marshall <mikemarsh17@gmail.com>
Update site2/docs/admin-api-topics.md
81cccb4
@Jason918
Copy link
Contributor Author

Jason918 commented Jun 16, 2021

@michaeljmarshall Thank you for your comments. All the comments are resolved, PTAL.

@Jason918
Copy link
Contributor Author

Jason918 commented Jul 9, 2021

@Anonymitaet Hi, Anyone we should invite to review to close this PR?

@Anonymitaet
Copy link
Member

Anonymitaet commented Jul 9, 2021

@Jason918 I think now it's fine, we can merge this PR after it passes the tests.

@Jason918
Copy link
Contributor Author

Jason918 commented Jul 9, 2021

@Jason918 I think now it's fine, we can merge this PR after it passes the tests.

@Anonymitaet Great, thanks a lot~

@Anonymitaet Anonymitaet merged commit 9607851 into apache:master Jul 9, 2021
@Jason918 Jason918 deleted the udpate_topic_stats_docs branch July 26, 2021 02:55
bharanic-dev pushed a commit to bharanic-dev/pulsar that referenced this pull request Mar 18, 2022
@Jason918 @Anonymitaet
@michaeljmarshall @splunk-xingw
[docs] Update docs for topic stats in admin apis. (apache#10868)
6dbba1d 
* update docs for topic stats

* Update site2/docs/admin-api-topics.md

Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/admin-api-topics.md

Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/admin-api-topics.md

Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/admin-api-topics.md

Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/admin-api-topics.md

Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/admin-api-topics.md

Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/admin-api-topics.md

Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/admin-api-topics.md

Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/admin-api-topics.md

Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/admin-api-topics.md

Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/admin-api-topics.md

Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/admin-api-topics.md

Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/admin-api-topics.md

Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>

* Update site2/docs/admin-api-topics.md

Co-authored-by: Michael Marshall <mikemarsh17@gmail.com>

* Update site2/docs/admin-api-topics.md

Co-authored-by: Michael Marshall <mikemarsh17@gmail.com>

* Update site2/docs/admin-api-topics.md

Co-authored-by: Michael Marshall <mikemarsh17@gmail.com>

* Update site2/docs/admin-api-topics.md

Co-authored-by: Michael Marshall <mikemarsh17@gmail.com>

* Update site2/docs/admin-api-topics.md

Co-authored-by: Jiang Haiting <jianghaiting@didichuxing.com>
Co-authored-by: Yu Liu <50226895+Anonymitaet@users.noreply.github.com>
Co-authored-by: Michael Marshall <mikemarsh17@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@michaeljmarshall michaeljmarshall michaeljmarshall left review comments

@Anonymitaet Anonymitaet Anonymitaet approved these changes

Assignees

No one assigned

Labels

doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Jason918 @Anonymitaet @michaeljmarshall