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

[Doc] improve style of shell commands #18088

Closed
2 tasks done
labuladong opened this issue Oct 18, 2022 · 4 comments · Fixed by #18526
Closed
2 tasks done

[Doc] improve style of shell commands #18088

labuladong opened this issue Oct 18, 2022 · 4 comments · Fixed by #18526
Labels
doc-required Your PR changes impact docs and you will update later. Stale

Comments

@labuladong
Copy link
Contributor

Search before asking

  • I searched in the issues and found nothing similar.

What issue do you find in Pulsar docs?

When I read the admin interface doc, I found that it's hard to distinguish between shell command and output.

For example:

image

image

What is your suggestion?

I suggest unifying the style of all shell commands:

  1. separate output and command this way:

image

  1. if it is a multi-line command, start with an indent and end with a slash, for example:

image

Any reference?

No response

Are you willing to submit a PR?

  • I'm willing to submit a PR!
@labuladong labuladong added the doc-required Your PR changes impact docs and you will update later. label Oct 18, 2022
@labuladong
Copy link
Contributor Author

cc @Anonymitaet @momo-jun

@momo-jun
Copy link
Contributor

@labuladong thanks for the finding. It makes sense to improve as you suggest.

@Anonymitaet
Copy link
Member

Good catch! @labuladong

@github-actions
Copy link

The issue had no activity for 30 days, mark with Stale label.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-required Your PR changes impact docs and you will update later. Stale
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants