You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/10/18 10:42:52 UTC
[GitHub] [pulsar] labuladong opened a new issue, #18088: [Doc] improve style of shell commands
labuladong opened a new issue, #18088:
URL: https://github.com/apache/pulsar/issues/18088
### Search before asking
- [X] I searched in the [issues](https://github.com/apache/pulsar/issues) and found nothing similar.
### What issue do you find in Pulsar docs?
When I read the [admin interface doc](https://pulsar.apache.org/docs/next/admin-api-tenants), I found that it's hard to distinguish between shell command and output.
For example:
### What is your suggestion?
I suggest unifying the style of all shell commands:
1. separate output and command this way:
<img width="1167" alt="image" src="https://user-images.githubusercontent.com/37220920/196408006-2f26b47f-1ea2-4f93-8503-f23aaba7f5c6.png">
2. if it is a multi-line command, start with an indent and end with a slash, for example:
<img width="650" alt="image" src="https://user-images.githubusercontent.com/37220920/196408519-1048fd7b-b8d4-49ea-a4ea-7ed354c51e3d.png">
### Any reference?
_No response_
### Are you willing to submit a PR?
- [X] I'm willing to submit a PR!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] momo-jun commented on issue #18088: [Doc] improve style of shell commands
Posted by GitBox <gi...@apache.org>.
momo-jun commented on issue #18088:
URL: https://github.com/apache/pulsar/issues/18088#issuecomment-1282279002
@labuladong thanks for the finding. It makes sense to improve as you suggest.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] tisonkun closed issue #18088: [Doc] improve style of shell commands
Posted by GitBox <gi...@apache.org>.
tisonkun closed issue #18088: [Doc] improve style of shell commands
URL: https://github.com/apache/pulsar/issues/18088
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] github-actions[bot] commented on issue #18088: [Doc] improve style of shell commands
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on issue #18088:
URL: https://github.com/apache/pulsar/issues/18088#issuecomment-1320751097
The issue had no activity for 30 days, mark with Stale label.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] labuladong commented on issue #18088: [Doc] improve style of shell commands
Posted by GitBox <gi...@apache.org>.
labuladong commented on issue #18088:
URL: https://github.com/apache/pulsar/issues/18088#issuecomment-1282189345
cc @Anonymitaet @momo-jun
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on issue #18088: [Doc] improve style of shell commands
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on issue #18088:
URL: https://github.com/apache/pulsar/issues/18088#issuecomment-1283536054
Good catch! @labuladong
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org