[fix][doc] improve and fix admin interface doc #18526
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
doc
2 tasks
|
@labuladong thanks for refreshing the API doc. I invited @zymap to take a look from a technical perspective. |
|
Cool! I'm looking into this :) |
tisonkun
reviewed
Nov 19, 2022
tisonkun
reviewed
Nov 19, 2022
site2/docs/admin-api-clusters.md
Outdated
| ``` | ||
| Output: | ||
|
|
||
| ```shell |
There was a problem hiding this comment.
Suggested change
| ```shell | |
| ```json |
tisonkun
reviewed
Nov 19, 2022
tisonkun
reviewed
Nov 19, 2022
site2/docs/admin-api-namespaces.md
Outdated
| ``` | ||
|
|
||
| ```json | ||
| ```shell |
There was a problem hiding this comment.
Suggested change
| ```shell | |
| ```json |
tisonkun
reviewed
Nov 19, 2022
site2/docs/admin-api-namespaces.md
Outdated
| ``` | ||
|
|
||
| ```json | ||
| ```shell |
There was a problem hiding this comment.
Suggested change
| ```shell | |
| ```json |
tisonkun
reviewed
Nov 19, 2022
site2/docs/admin-api-namespaces.md
Outdated
| @@ -1171,9 +1197,7 @@ You can get a configured entry filter for a given namespace. | |||
| <TabItem value="pulsar-admin"> | |||
|
|
|||
| ``` | |||
tisonkun
reviewed
Nov 19, 2022
site2/docs/admin-api-namespaces.md
Outdated
| @@ -1207,9 +1229,7 @@ You can remove entry filters policies for a given namespace. | |||
| <TabItem value="pulsar-admin"> | |||
|
|
|||
| ``` | |||
tisonkun
reviewed
Nov 19, 2022
tisonkun
reviewed
Nov 19, 2022
|
The rest looks good to me. |
Co-authored-by: tison <wander4096@gmail.com>
Co-authored-by: tison <wander4096@gmail.com>
|
Thanks for your review~ PTAL @tisonkun |
tisonkun
approved these changes
Nov 19, 2022
lifepuzzlefun
pushed a commit
to lifepuzzlefun/pulsar
that referenced
this pull request
Dec 9, 2022
Co-authored-by: tison <wander4096@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #18088
Fixes #18517
Fixes #18514
Fixes #18525
Fixes #18516
Modifications
Go through the admin document, improve command style and fix errors.
Documentation
docdoc-requireddoc-not-neededdoc-complete