Editing pages
If you spot something that could be improved in a page, please feel free to edit it!
This wiki is built upon the collaboration of DAE students using Linux, but courses are ever-changing and experiences from newer students are needed to keep this knowledge base up-to-date!
General guidelines
Syntax and style
Pages are written in pure Markdown, to keep the format portable. You can find a cheat sheet for the syntax here.
Section titles use the ## heading size, and sub-sections use ###.
Use code blocks for commands or scripts. These take the form of:
```language
// code or command goes here
```
If it's a console command, please prepend it with a $ to indicate so!
Accessibility
When inserting an image, try to include ALT text. This is an image description that goes in between the square brackets (here: ). Three reasons to do this:
- Accessibility: screen readers (software that reads a page back to you) requires ALT text to describe an image. Some folks depend on these.
- Dead links: If an image URL ever stops working, future readers will still have the description to go off of.
- Text-mode: Most text-mode browsers cannot display images, and instead show ALT text. This also applies to some Markdown viewers.
Structure
When describing a process or piece of software, try to include screenshots (with ALT text!) so someone following along with the page can check that they're on the right track!
When running a command that is not commonly available on Linux distros, please indicate where this can be obtained. If you can, add a command to install the dependencies for your distro (Arch Linux and Debian instructions preferred).