NixOS Wiki:Contributing: Difference between revisions
imported>Makefu m Makefu moved page Contributing to to the wiki to Contributing to the wiki without leaving a redirect: fucked up |
imported>Ixxie No edit summary |
||
| Line 3: | Line 3: | ||
The mediawiki provides a way to tag articles at the end of the article. We are using this feature to somewhat structure the wiki. | The mediawiki provides a way to tag articles at the end of the article. We are using this feature to somewhat structure the wiki. | ||
=== | === Ecosystem Tags === | ||
Elements of the Nix Ecosystem should be tagged by one or more of the following categories: | |||
* <pre>[[Category:NixOS]]</pre> | * <pre>[[Category:NixOS]]</pre> | ||
| Line 22: | Line 22: | ||
** PaaS based on nix | ** PaaS based on nix | ||
=== Resource === | === 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: | The [https://www.divio.com/en/blog/documentation/ Type of documentation] for new pages should be tagged with one of the following categories: | ||
Revision as of 07:08, 23 August 2017
Tagging Articles
The mediawiki provides a way to tag articles at the end of the article. We are using this feature to somewhat 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 acomplish 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]]
- the nixops tool and eco-system
[[Category:Hydra]]
- Continuous Integration related Documentation
[[Category:Disnix]]
- PaaS based on nix
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:How-To]]
- is goal-oriented
- shows how to solve a specific problem
- is a series of steps
[[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
- Types of Documentation: https://www.divio.com/en/blog/documentation/
- Wiki Restructuring Discussion: https://github.com/nixos-users/wiki/issues/3