Skip to content

[fix][doc] improve and fix admin interface doc#18526

Merged
tisonkun merged 9 commits intoapache:masterfrom
labuladong:fix-admin-doc
Nov 19, 2022
Merged

[fix][doc] improve and fix admin interface doc#18526
tisonkun merged 9 commits intoapache:masterfrom
labuladong:fix-admin-doc

Conversation

@labuladong
Copy link
Contributor

@labuladong labuladong commented Nov 17, 2022

Fixes #18088

Fixes #18517

Fixes #18514

Fixes #18525

Fixes #18516

Modifications

Go through the admin document, improve command style and fix errors.

Documentation

  • doc
  • doc-required
  • doc-not-needed
  • doc-complete

@github-actions github-actions bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Nov 17, 2022
@labuladong
Copy link
Contributor Author

cc @momo-jun @Anonymitaet

@momo-jun
Copy link
Contributor

@labuladong thanks for refreshing the API doc. I invited @zymap to take a look from a technical perspective.

@tisonkun
Copy link
Member

Cool! I'm looking into this :)

@tisonkun tisonkun self-requested a review November 18, 2022 16:07
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
```shell
```json

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
```shell
```json

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
```shell
```json

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
```
```shell

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
```
```shell

@tisonkun
Copy link
Member

The rest looks good to me.

labuladong and others added 4 commits November 19, 2022 13:27
Co-authored-by: tison <wander4096@gmail.com>
Co-authored-by: tison <wander4096@gmail.com>
@labuladong
Copy link
Contributor Author

Thanks for your review~ PTAL @tisonkun

Copy link
Member

@tisonkun tisonkun left a comment

Choose a reason for hiding this comment

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

LGTM.

All the changes are about formatting or fixing typos. The command change for Getting Started Standalone is verified locally.

Merging...

@tisonkun tisonkun merged commit 23d8f49 into apache:master Nov 19, 2022
@labuladong labuladong deleted the fix-admin-doc branch November 19, 2022 06:18
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

Labels

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

Projects

None yet

3 participants

Comments