|
|
| Line 1: |
Line 1: |
| | | #Redirect [[Contributing]] |
| | |
| == 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:
| |
| ; <code>[[:Category:NixOS|<nowiki>[[Category:NixOS]]</nowiki>]]</code>: Articles related to the Nix operating system, the module system and the system configuration.
| |
| ; <code>[[:Category:Nix|<nowiki>[[Category:Nix]]</nowiki>]]</code>: Articles about using the Nix Tools to accomplish great things.
| |
| ; <code>[[:Category:Nixpkgs|<nowiki>[[Category:Nixpkgs]]</nowiki>]]</code>: Articles about maintaining code in the Nixpkgs repository, structuring, and so on.
| |
| ; <code>[[:Category:Nix Language|<nowiki>[[Category:Nix Language]]</nowiki>]]</code>: Description of language quirks and solutions.
| |
| ; <code>[[:Category:Hydra|<nowiki>[[Category:Hydra]]</nowiki>]]</code>: Articles about Hydra continuous Integration related documentation.
| |
| ; <code>[[:Category:Application|<nowiki>[[Category:Application]]</nowiki>]]</code>: Extended Ecosystem: Articles about other Nix-based or Nix-related applications.
| |
| | |
| === Topic tags ===
| |
| Almost all content of the wiki can be accessed with 2 to 3 clicks via one of these topic categories:
| |
| ; <code>[[:Category:Software|<nowiki>[[Category:Software]]</nowiki>]]</code>: Articles about software applications like neovim or libreoffice
| |
| ; <code>[[:Category:Hardware|<nowiki>[[Category:Hardware]]</nowiki>]]</code>: Articles about hardware like GPU, keyboards and notebooks.
| |
| ; <code>[[:Category:Desktop|<nowiki>[[Category:Desktop]]</nowiki>]]</code>: Articles about using NixOS on a PC (e.g. desktop environments)
| |
| ; <code>[[:Category:Server|<nowiki>[[Category:Server]]</nowiki>]]</code>: Articles about using NixOS on servers, like running web applications (e.g. Nextcloud)
| |
| ; <code>[[:Category:Community|<nowiki>[[Category:Community]]</nowiki>]]</code>: Articles about the Nix(OS) community and how to engage and contribute.
| |
| | |
| === Resource tags ===
| |
| | |
| The [https://www.divio.com/en/blog/documentation/ type of documentation] for new pages should be tagged with one of the following categories:
| |
| ; <code>[[:Category:Tutorial|<nowiki>[[Category:Tutorial]]</nowiki>]]</code>:
| |
| :* is learning-oriented
| |
| :* allows the newcomer to get started
| |
| :* is a lesson
| |
| ; <code>[[:Category:Discussion|<nowiki>[[Category:Discussion]]</nowiki>]]</code>:
| |
| :* is understanding-oriented
| |
| :* explains
| |
| :* provides background and context
| |
| ; <code>[[:Category:Guide|<nowiki>[[Category:Guide]]</nowiki>]]</code>:
| |
| :* is goal-oriented
| |
| :* how-to's for dealing with a specific problem / tool
| |
| :* is a series of steps
| |
| ; <code>[[:Category:Cookbook|<nowiki>[[Category:Cookbook]]</nowiki>]]</code>:
| |
| :* is recipe orientated
| |
| :* a collection of short code snippets and hacks
| |
| :* arranged around a theme or tool
| |
| ; <code>[[:Category:Reference|<nowiki>[[Category:Reference]]</nowiki>]]</code>:
| |
| :* is information-oriented
| |
| :* describes the machinery
| |
| :* is accurate and complete
| |
| :* Most of the time the NixOS Wiki will not contain reference documents
| |
| | |
| == References ==
| |
| | |
| * [https://www.divio.com/en/blog/documentation/ Types of Documentation]
| |
| | |
| [[Category:Community]]
| |
