Screenshot 2023-04-20 at 17.59.10.png
Screenshot 2023-04-27 155309.png
Team D
[ZBX-22708] Make all insets with command examples the same Created: 2023 Apr 20 Updated: 2024 Apr 10 Resolved: 2023 May 31 |
|
| Status: | Closed |
| Project: | ZABBIX BUGS AND ISSUES |
| Component/s: | Documentation (D) |
| Affects Version/s: | 6.0.16, 6.4.1 |
| Fix Version/s: | 7.0 (plan) |
| Type: | Documentation task | Priority: | Trivial |
| Reporter: | Alex Kalimulin | Assignee: | Martins Valkovskis |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Attachments: |
Screenshot 2023-04-20 at 17.59.10.png
Screenshot 2023-04-27 155309.png
|
| Team: | Team D |
| Sprint: | Sprint 99 (Apr 2023), Sprint 100 (May 2023) |
| Story Points: | 2 |
| Description |
|
There are many command examples across the documentation and there is no consistency of command prompts. This page uses 3 The documentation should choose one consistent style. One possible solution is not using any prompt for single-command insets at all but use $ for multi-command insets. The latter can be handy when showing insets with many commands some of which can be multi-line:
|
| Comments |
| Comment by Martins Valkovskis [ 2023 Apr 27 ] |
|
After discussing with rnovarro, we have come up with the proposal not to use any prompt unless absolutely necessary for comprehension. The reasoning is that if we leave $ for multiline commands then it again creates inconsistency in a page where a single line command is followed by commands on, say, two lines and then again by a single line command. And here's a use case for keeping the $ prompt:
<rnovarro > All insets brought to the abovementioned standard for Documentation v7.0 and v6.0 |
variants: "shell>", "$", an empty prompt. 
