|
|
| (53 intermediate revisions by 13 users not shown) |
| Line 1: |
Line 1: |
| | | #Redirect [[Contributing]] |
| == 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.
| |
| # '''Reticulate''': the manuals are *catenary* meaning they have a linear sequence of one chapter following another while the wiki is *reticulate*, having a network structure of links, 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.
| |
| | |
| == 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:
| |
| | |
| * <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:Guide]]</pre>
| |
| ** is goal-oriented
| |
| ** how-to's for dealing with a specific problem / tool
| |
| ** is a series of steps
| |
| | |
| * <pre>[[Category:Cookbook]]</pre>
| |
| ** is recipe orientated
| |
| ** a collection of short code snippets and hacks
| |
| ** arranged around a theme or tool
| |
| | |
| * <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
| |
