title: Verb progressive: Add A Printer. Fix An Issue. Find A Guide. Restore Your Computer. Upgrade Ubuntu. Access Boot Menu. Change Settings. Install Programs. Use Title Case.
description: >
Short and sweet. Keep it to 3 or less sentences for brevity on the listing page.
keywords:
- Add some useful ones for searching
image: https://d1vhcvzji58n1j.cloudfront.net/images/newsletter/2016-10/16-c1f27f8de8.10.jpg
(This is for slack and other linked reference sites)
section:
FAQ - Important stuff
articles - Average stuff
Known Solutions - When we have lingering bugs
First, info about the topic. The main title is already in the blue bar so don't repeat with another heading.
3 hash for steps or specific parts of the document. These are the main points of the document. Don't number these and use Title Case. Use header language.
Put more steps here.
4 hash subpoints. These are the minor points under the major points. Use line breaks as need for clarity.
More info about the info here
At the end of any document, add these 4 sections as needed in this order.
How to troubleshoot an issue
Talk about programs and other programs that can be used on this topic. Then tell the commands to install them:
sudo apt install program
command
What it does
command 2
What it does
question
Answer
Here are links and external resources. Other relevant info can be put here.
Anything actionable. Anything clicked on:
Buttons or Menu Options or Radial Buttons or Checkboxes or Tabs or Options to pick
Any programs or applications or software:
Programs or Applications or Things to Run
Things Typed into boxes
'Window or Dialog Titles'
"Things referenced on a window or log"
Talking about a command should go on its own line:
Singular commands
And then text can continue. Wrap all commands in full length blocks. For lots of commands in a row, use a block:
Lots of commands
Here
Run this
*This is a small note
Keyboard keys:
CTRL+ALT+F1
If you are talking about terminal items such as /dev/sda or [sudo] password for james: or Bus 002 Device 002: ID 8087:8000 Intel Corp. should go in a code block.
File locations such as /usre/share/xsessions or files such as meer1-bios.zip are also wrapped in a code block.
Text to enter in config files
More text
config=1
put 2 spaces after text to force the new line
don't forget!
Referencing a single file:
/var/log/syslog
Lists:
- Item 1
- Sub-Item 1
- Sub-Item 2
- Item 2
- Item 3
Volume Icon:
User Icon:
Gear Icon:
Ubuntu Icon:
Ubuntu Key:
Pop Key:
An arrow:
Do this → Do that → Yay!
Long Dash:
—
Links are orange on our site:
links
Images are in the image folder:
If talking about several options on a screen, put them in a table:
| Option | Action |
|---|---|
| Item | Talk about the thing |
| Thing | About the thing |
| Thing 2 | more about the thing |
| Left Formatting | Centered Text | Right Formatted |
|---|---|---|
| Left | Center | Right |
| Use the colon | Put it | Where you want |
Bugs:
Any additional people that mark Does this bug affect you? on that bug report will help gain additional traction from developers to get this issue resolved.