NixOS Wiki:Contributing

From NixOS Wiki
Revision as of 16:48, 9 December 2017 by Ixxie (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This article is a guide to contributing to the Wiki. Contributors are encouraged to write new articles or modify existing ones as they see fit, but it is appreciated and encouraged to follow the recommendations of this guide as for as possible whenever they are applicable.

Spirit of the Wiki

The NixOS User Wiki is a community effort, meant to be complementary to the manuals rather than a replacement for them. The following properties distinguish the spirit of the Wiki from that of the official documentation:

Ecosystemic
The manuals cover specific software (Nix, NixOS, etc.) while the Wiki covers the Nix ecosystem as a whole, helping the user understand the interrelations more clearly.
Heterogeneous
The manuals normally give one canonical approach to something, the Wiki has the potential to reveal the more diverse approaches and workflows used in practice.
Pragmatic
The manuals are intended for comprehensive and detailed reference, while the Wiki could emphasize practical and learning resources such as guides, tutorials and cookbooks.
Networked
The manuals are sequential with one chapter following another while the Wiki is networked, with various articles linked to one another in various ways, allowing the user to reach information in multiple ways.
Community
The manuals cover the more official and stable core of the Nix ecosystem, while the Wiki can cover the whole Nix community with its diverse projects and communication channels.

Finding stuff to do

The following are ways to find out (or let people know) what needs to be done:

  • Use the Wiki Projects page to list or join a project and the Wiki Issues page to raise issues and find stuff to do.
  • Help improve flagged articles in the appropriate way.
  • Fill out missing articles linked anywhere (Special:WantedPages), and missing sections in any article.
  • Write tutorials and guides to help ease pain-points for beginners.
  • Check the Wiki To-Do List.

Style

Language

NixOS Wiki articles should be written in clear, standard and professional language. To this end, the following considerations apply:

Accessibility
Wiki articles are often the first thing a new user will read about any subject, so they should be accessible to beginners.
Vocabulary
Use the simplest and most conventional words and expressions you can find to get your point across without oversimplifying.
Organization
Keep your text structured in coherent sentences, paragraphs and sections, each with its own clear themes and topics.
Citations
Citations aren't required, but definitely appreciated; when citing code, hardlink to a particular revision.
Attribution
Where external material is quoted or utilized in the article, and/or licensing or common sense demands it, place clear and complete attribution and (where possible) a link.

Syntax

Make sure to:

  • Follow standard capitalization for software, particularly for the Nix ecosystem (NixOS, Nix, Nix Language, Nixpkgs, NixOps and Hydra).
  • Use inline <code> tags for filenames, paths, commands and command-line tools.
  • Use <syntaxhighlight lang="nix"> for code snippets. Change lang= to match the actual language of the code.
  • Use the secondary MediaWiki header (== My Section ==) for main sections (the primary header should never be used).

Code

Articles can and often should contain plenty of code snippets and blocks. When using code consider the following:

Quantity
Code examples should be minimal, to-the-point, and only used when illustrative of the surrounding text.
Style
Code should be properly indented with clear naming and commenting where necessary.

Tagging articles

The MediaWiki provides a way to tag articles (at the end of the article). We are using this feature to structure the Wiki.

Ecosystem tags

Elements of the Nix Ecosystem should be tagged by one or more of the following categories:

[[Category:NixOS]]
Articles related to the Nix Operating System, the Module System and the System Configuration.
[[Category:Nix]]
Articles about Using the Nix Tools to accomplish great things.
[[Category:Nixpkgs]]
Articles about Maintaining code in the Nixpkgs repository, structuring, and so on.
[[Category:Nix Language]]
Description of Language quirks and solutions.
[[Category:NixOps]]
Articles about the NixOps tool and ecosystem.
[[Category:Hydra]]
Articles about Hydra continuous Integration related documentation.
[[Category:Disnix]]
Articles about Disnix, the Nix-based microservice architecture.
[[Category:Application]]
Articles about other Nix-based or Nix-related applications.

Resource tags

The type of documentation for new pages should be tagged with one of the following categories:

[[Category:Tutorial]]
  • is learning-oriented
  • allows the newcomer to get started
  • is a lesson
[[Category:Discussion]]
  • is understanding-oriented
  • explains
  • provides background and context
[[Category:Guide]]
  • is goal-oriented
  • how-to's for dealing with a specific problem / tool
  • is a series of steps
[[Category:Cookbook]]
  • is recipe orientated
  • a collection of short code snippets and hacks
  • arranged around a theme or tool
[[Category:Reference]]
  • is information-oriented
  • describes the machinery
  • is accurate and complete
  • Most of the time the NixOS Wiki will not contain reference documents

References