Propose CLI command guidance in style guide
In Add information about glab deploy key commands (!194221 - merged), I'm proposing changes to the deploy-keys page. I want to mention glab
CLI commands more regularly as part of GUI-focused subheadings.
We haven't defined how we want to do that, though, and I see a couple of ways we COULD do it.
Option 1: prepend with in-repo link
To do XYZ, run the
glab deploy-key add
CLI command, or in the UI:
- Pro: internal link checked more often
- Neutral: adds link early in the procedure
- Con: requires extra clicks if the user wants to see the docs for the command itself, as this link is more generic
Option 2: prepend with external link
To do XYZ, run the
glab deploy-key add
CLI command, or in the UI:
- Pro: more specific link
- Neutral: adds link early in the procedure
- Con: external links are checked less frequently
Option 3: append
We could also add a standalone line at the end of the procedure, saying something like
The GitLab CLI provides a
glab deploy-key list
command.
- Pro: keeps the introductory stem simpler
- Neutral: we could do the internal or external link
- Con: if we place the command mention at the end, it's not shown as an option when the user is starting the procedure
To do
Get feedback from other TWs, and create a style guide proposal.
Edited by Amy Qualls