You are browsing a read-only backup copy of Wikitech. The live site can be found at wikitech.wikimedia.org
Difference between revisions of "SRE/Data Persistence/Documentation guidelines"
|Line 21:||Line 21:|
Latest revision as of 09:42, 9 June 2021
- If you notice a mistake / gap requiring a simple update, JUST DO IT™.
- If you notice a mistake / gap requiring a non-trivial update, add the documentation review include.
- Keep the documentation pages as short as possible. Any self-contained section should be its own page.
- If you realize we need to document something but don't have the time to do it, create a stub page with a short description and the documentation review and footer includes.
Documentation review (pages requiring comprehensive review)
Add the following at the top of the page:
Add the following at the bottom of the page: