Replies: 2 comments 1 reply
-
I agree with David's examples... my thinking is that we use |
Beta Was this translation helpful? Give feedback.
1 reply
-
I largely agree, although I would suggest to limit the use of |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Brainstorming for now.
Sometimes we see "Press
kbd:[Enter]
", sometimes "Pressq
to quit", sometimes "Type:q
", and various other combinations. It would be nice to have conventions for press/type/enter and also for the markup that's used.E.g.
0
, or by typing:0
inansible-navigator
:"Why use "pressing" for the first and "typing" for the second? Not saying it's wrong; just asking.
Some more things:
kbd:[Enter]
to engage warp drive.kbd:[Ctrl+Alt+Del]
to eject the warp core.warp 8
in thebtn:[Max Warp]
field.:q
to retract the assimilation tubules.Here's another example:
2. "In the preceding example, if you press
2
or enter:2
, then details of the "Ensure HAProxy is started and enabled" task are displayed, and you can use the arrow keys to scroll through the results:"Another example:
3. "If you are running
ansible-navigator
in interactive mode, then you can type the:help
command to open a help page."I'd be much more inclined to write "...you can use the
:help
command..." in this case, or "...type:help
to open a help page."@mweetman-redhat @StyleGuides/style-guide-committers
Beta Was this translation helpful? Give feedback.
All reactions