Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2024-10-01 01:25:40 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add guidelines regarding angled brackets around variables

Browse Source 
Added in response to:
https://qubes-os.discourse.group/t/how-can-i-create-a-template-hvm-of-any-os/4676

Also updates terminology and clarifies wording.
This commit is contained in:
Andrew David Wong 2021-06-27 22:25:46 -07:00
parent b4e501f9cd
commit 1c5aab4340
No known key found for this signature in database
GPG Key ID: 8CE137352A019A17
1 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
developer/general/doc-guidelines.md
View File

@ -415,17 +415,32 @@ For further discussion about version-specific documentation in Qubes, see
* Syntactically distinguish variables in commands. For example, this is * Syntactically distinguish variables in commands. For example, this is
ambiguous: ambiguous:
$ qvm-run --dispvm=dvm-template --service qubes.StartApp+xterm $ qvm-run --dispvm=disposable-template --service qubes.StartApp+xterm
It should instead be: It should instead be:
$ qvm-run --dispvm=<DVM_TEMPLATE> --service qubes.StartApp+xterm $ qvm-run --dispvm=<DISPOSABLE_TEMPLATE> --service qubes.StartApp+xterm
Note that we syntactically distinguish variables in three ways: Note that we syntactically distinguish variables in three ways:
1. Surrounding them in angled brackets (`< >`) 1. Surrounding them in angled brackets (`< >`)
2. Using underscores (`_`) between words 2. Using underscores (`_`) instead of spaces between words
3. Using all capital letters 3. Using all capital letters
We have observed that many novices make the mistake of typing the surrounding
angled brackets (`< >`) on the command line, even after substituting the
desired real value between them. Therefore, in documentation aimed at
novices, we also recommend clarifying that the angled brackets should not be
typed. This can be accomplished in one of several ways:
- Explicitly say something like "without the angled brackets."
- Provide an example command using real values that excludes the angled
brackets.
- If you know that almost all users will want to use (or should use) a
specific command containing all real values and no variables, you might
consider providing exactly that command and forgoing the version with
variables. Novices may not realize which parts of the command they can
substitute with different values, but if you've correctly judged that they
should use the command you've provided as is, then this shouldn't matter.
## Markdown conventions ## Markdown conventions
All the documentation is written in Markdown for maximum accessibility. When All the documentation is written in Markdown for maximum accessibility. When