Update Editing

[xonotic/xonotic.wiki.git] / Editing.md

diff --git a/Editing.md b/Editing.md
index a1c40ba016c88badc64821568c7f32e70b5e9940..c2d39161cc313d6fb0e2f06092ec3773b8c5e104 100644 (file)
--- a/Editing.md
+++ b/Editing.md
@@ -1,15 +1,25 @@
+Getting access
+--------------
+
 If you want write access, please ask for it at [#xonotic on FreeNode](https://webchat.freenode.net/) so we know you're not a bot, we'll gladly give it to you (unfortunately, there is no way to allow anonymous editing on GitLab). After that, you can edit the wiki online (there is an Edit button when logged in) or clone it to your machine using git (`git clone git@gitlab.com:xonotic/xonotic.wiki.git`).
 
-The official version is on [GitLab](https://gitlab.com/xonotic/xonotic/wikis/home) but we also sync the wiki to [GitHub](https://github.com/xonotic/xonotic/wiki). Please, follow this guide when editing to make sure everything works properly on both.
+
+Guidelines
+----------
 
 - Try to keep things short and to the point
-- Avoid creating lists of stuff that people will need to keep up to date, it doesn't work
-- Don't duplicate information, there should be a single up-to-date source of truth, everything else should link to it
-    - Improve things instead of starting from scratch, if the previous author didn't finish, you're not likely to do better if you start from nothing
+- Don't duplicate information - everything should have a single up-to-date source of truth, other places should link to it
+- Avoid creating lists of stuff (e.g. cvars, command line flags, maps, ...) that people will need to keep up to date manually, it doesn't work. Instead link to where you got the information (e.g. [CACS](https://www.xonotic.org/tools/cacs/)) or teach people how to get it themselves (e.g. `apropos`).
+- Improve things instead of starting from scratch, if the previous author didn't finish, you're not likely to do better if you start from nothing
 
 
-Links to pages
---------------
+GitHub mirror
+-------------
+
+The official version of this wiki is on [GitLab](https://gitlab.com/xonotic/xonotic/wikis/home) but we also sync the wiki to [GitHub](https://github.com/xonotic/xonotic/wiki). Please, follow this guide when editing to make sure everything works properly on both.
+
+
+### Links to other pages
 
 Use standard markdown links: `[Text](link)` (e.g. `[Back to main page](Home)` to get [Back to main page](Home))
 
@@ -19,8 +29,7 @@ Use standard markdown links: `[Text](link)` (e.g. `[Back to main page](Home)` to
 Links don't seem to be case sensitive but it's probably best to use proper capitalization just in case it breaks in some edge case somewhere.
 
 
-New files
----------
+### New files
 
 For pages, capitalize at least the first letter of the filename (GitHub doesn't capitalize titles automatically, GitLab will do what it wants anyway).
 
@@ -29,7 +38,6 @@ Use dashes in page names, not underscores, not spaces - dashes get converted to
 It's ok (and preferred) to put images and other assets into subdirectories but we have to **put pages in root** because GitHub doesn't support subdirs properly (it flattens everything - this can cause collisions, plus there is no way to link from subdir to another subdir that works on both GitLab and GitHub).
 
 
-Automated checking
--------------------
+### Automated checking
 
 Neither GL not GH support red links (highlighting broken links) so there's a script in [`assets/check-and-fix.py`](assets/check-and-fix.py) that finds broken links and unreachable files. To use it, clone the wiki and run the script in its root. It can also automatically move or rename files that don't follow the above guidelines if you run it with `--fix`.