|
|
| Line 1: |
Line 1: |
| 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 Wiki is a ''user community'' effort, meant to be complementary to the [https://nixos.org/manual/nixos/stable/ NixOS reference manual] rather than a replacement for it. The following properties distinguish the spirit of the Wiki from reference documentation:
| |
| ; Ecosystemic: The manuals cover the interfaces and mechanisms of specific components (Nix, Nixpkgs, NixOS, etc.) while the Wiki covers the Nix ecosystem as a whole and focuses on NixOS as a point of integration.
| |
| ; Heterogeneous: The reference manuals merely present all interfaces factually. The Wiki has the potential to reveal the more diverse or opinionated approaches and workflows used in practice.
| |
| ; Pragmatic: The reference manuals are intended for comprehensive and detailed reference, while the Wiki emphasizes practical resources such as guides, examples, and troubleshooting tips.
| |
| ; User community: The reference manuals cover mechanisms and inner workings, which are mainly important for developers and contributors. The Wiki is oriented around the broad spectrum of real-world use cases.
| |
|
| |
| == Finding stuff to do ==
| |
|
| |
| The following are ways to find out (or let people know) what needs to be done:
| |
| * Use the [https://github.com/NixOS/nixos-wiki-infra/projects Wiki Projects] page to list or join a project and the [https://github.com/NixOS/nixos-wiki-infra/issues Wiki Issues] page to raise issues and find stuff to do.
| |
| * Help improve flagged articles in the appropriate way.
| |
| * Flag articles if you find something missing, incorrect or out-of-date using [[Help:Template|templates]].
| |
| * Update [[Special:WhatLinksHere/Template:Outdated|outdated articles]].
| |
| * Fill out [[Special:WantedPages|missing articles]], and missing sections in any article.
| |
| * Write [[:Category:Tutorial|tutorials]] and [[:Category:Guide|guides]] to help ease pain-points for beginners.
| |
|
| |
| == Who Can Contribute? ==
| |
|
| |
| The NixOS wiki is open for anyone with an account to contribute in the ways listed above. However, wiki moderators have the final say on what can or cannot be on the wiki. For any questions or concerns, the moderation can be contacted through the [https://matrix.to/#/#wiki:nixos.org NixOS wiki matrix room].
| |
|
| |
|
| === Workgroups === | | === Workgroups === |
| Line 80: |
Line 57: |
|
| |
|
| * [https://www.divio.com/en/blog/documentation/ Types of Documentation] | | * [https://www.divio.com/en/blog/documentation/ Types of Documentation] |
| * [https://github.com/nixos-users/wiki/issues/3 Wiki Restructuring Discussion]
| |
|
| |
|
| [[Category:Guide]]
| |
| [[Category:Community]] | | [[Category:Community]] |