Skip to content
This repository has been archived by the owner on Apr 1, 2024. It is now read-only.

ISSUE-18088: [Doc] improve style of shell commands #5001

Open
2 tasks done
sijie opened this issue Oct 18, 2022 · 0 comments
Open
2 tasks done

ISSUE-18088: [Doc] improve style of shell commands #5001

sijie opened this issue Oct 18, 2022 · 0 comments

Comments

@sijie
Copy link
Member

sijie commented Oct 18, 2022

Original Issue: apache#18088


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!
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant