Wiki rules

The rules are short on purpose. They exist so that anyone can read a wiki page and trust it enough to try it.

What belongs here

• Fixes you found yourself, with the symptom, the cause and the steps that worked
• Tips that save time, with an example people can copy
• Experiences: what happened, what you did, and what you would do differently
• Ideas worth trying, clearly marked as ideas

What does not belong here

• Basic questions or support requests. This is a notebook, not a help desk.
• Topics the main site already covers well. Add to those pages instead, and link them with site: links.
• Passwords, keys, tokens, internal hostnames, customer data or anything your employer would not want public. The automatic check looks for obvious secrets, but it is your job to check.
• Names or identifying details of real people, companies or clients. Tell the story without them.
• Text copied from somewhere else without the right to share it.
• Adverts, affiliate links and anything that is mainly there to promote something.

How to write a good page

1. Say what you saw first, with the exact error message.
2. Give commands that can be copied and pasted, in code blocks.
3. Say what you tested them on in tested_on. Do not guess.
4. Warn clearly before any command that deletes or overwrites data.
5. Explain why it works in a sentence or two.

Licence and credit

By contributing you confirm that the text is yours to share, and you agree that it is published under the Creative Commons Attribution-ShareAlike 4.0 licence (CC BY-SA 4.0). Anyone may reuse it, as long as they credit the wiki and share their changes under the same licence. Your name appears on the page only if you put it in the author setting, but the public commit history on GitHub shows who made each change.

Review and removal

Every change is read by the site owner before it is published. A change may be edited, declined or removed later if it turns out to be wrong, unsafe or off topic. If you see something that should not be here, open an issue in the repository or contact the site.