Help:Editing: Difference between revisions

From NixOS Wiki
imported>Samueldr
Adds a tentative description for a preferred tone for articles
imported>Mth
Refactor "See also"
Line 53: Line 53:
{{expansion|Look at the mediawiki documentation meanwhile!}}
{{expansion|Look at the mediawiki documentation meanwhile!}}


<hr />
== See also ==


== Resources ==
* [https://www.mediawiki.org/wiki/Help:Formatting Help:Formatting, MediaWiki], the upstream documentation.
 
* [https://en.wikibooks.org/wiki/Editing_Wikitext Editing Wikitext, Wikibooks], a book about editing wikitext.
=== Mediawiki help ===
* [https://meta.wikimedia.org/wiki/Help:Section Help:Sections, Wikimedia]. While about the wikimedia wikis, these documents may help with some peculiarities about mediawiki.
These documents are the upstream documentation.
 
* [https://www.mediawiki.org/wiki/Help:Formatting Formatting]
 
=== Wikimedia Help ===
While about the wikimedia wikis, these documents may help with some peculiarities about mediawiki.
 
* [https://meta.wikimedia.org/wiki/Help:Section Sections]

Revision as of 07:22, 22 April 2019

Articles tone

Use a more descriptive tone, where concepts and instructions are described and explained first. A prescriptive tone should be avoided.

Here's an example:

Prescriptive Descriptive

How to deal with full /boot in case of EFI

systemd-boot (gummiboot) can't store kernels, initrd and other big stuff on root partition, so switch to grub

Keeping kernels/initrd on the main partition

For these instructions, GRUB will be required; systemd-boot cannot reference boot files from the root partition. This will differ from the default expectation of NixOS on EFI, where /boot/ is the ESP.

On the prescriptive side, the title doesn't describe the achieved end-result; the text tells the reader to switch to grub without explaining what the following (elided) configuration does.

Style guide

Titles

  • Capitalize only the first word.

Universal sections

Some pages will have sections in common. It would be wise to ensure the titles are the same across all pages.

Section Description
See also References inside and outside the wiki. Prefer textual links with a description than naked URLs.
References The last section, when needed, where sections will output the references.

Using

See also