|
|
| (58 intermediate revisions by 13 users not shown) |
| Line 1: |
Line 1: |
| == Tagging Articles ==
| | #Redirect [[Contributing]] |
| | |
| 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>
| |
| ** Articles related to the Nix Operating System, the Module System and the System Configuration
| |
| * <pre>[[Category:Nix]]</pre>
| |
| ** Articles about Using the Nix Tools to acomplish great things
| |
| * <pre>[[Category:Nixpkgs]]</pre>
| |
| ** Articles about Maintaining code in the nixpkgs repository, structuring, and so on
| |
| * <pre>[[Category:Nix Language]]</pre>
| |
| ** Description of Language Quirks and Solutions
| |
| * <pre>[[Category:NixOps]]</pre>
| |
| ** [https://github.com/NixOS/nixops the nixops tool] and eco-system
| |
| * <pre>[[Category:Hydra]]</pre>
| |
| ** Continuous Integration related Documentation
| |
| * <pre>[[Category:Disnix]]</pre>
| |
| ** PaaS based on nix
| |
| | |
| === 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:
| |
| | |
| * <pre>[[Category:Tutorial]]</pre>
| |
| ** is learning-oriented
| |
| ** allows the newcomer to get started
| |
| ** is a lesson
| |
| | |
| * <pre>[[Category:Discussion]]</pre>
| |
| ** is understanding-oriented
| |
| ** explains
| |
| ** provides background and context
| |
| | |
| * <pre>[[Category:How-To]]</pre>
| |
| ** is goal-oriented
| |
| ** shows how to solve a specific problem
| |
| ** is a series of steps
| |
| | |
| * <pre>[[Category:Reference]]</pre>
| |
| ** 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
| |
