|
|
| (34 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.
| |
| # '''Networked''': the manuals are ''sequential'' with one chapter following another while the wiki is ''networked'', with various articles linked to one another in various ways, 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.
| |
| | |
| ==Style==
| |
| | |
| ===Language===
| |
| | |
| NixOS Wiki articles should be written in clear, standard and professional language. To this end, the following considerations apply:
| |
| | |
| * ''Vocabulary'': use the simplest and most conventional words and expressions you can find to get your point across without oversimplifying.
| |
| * ''Organization'': keep your text structured in coherent sentences, paragraphs and sections, each with its own clear themes and topics.
| |
| * ''Citations'': citations aren't required, but definitely appreciated; when citing code, hardlink to a particular revision.
| |
| * ''Attribution'': where external material is quoted or utilized in the article, and/or licensing or common sense demands it, place clear and complete attribution and (where possible) a link.
| |
| | |
| ===Code===
| |
| | |
| Articles can and often should contain plenty of code snippets and blocks. When using code consider the following:
| |
| | |
| * ''Quantity'': code examples should be minimal, to-the-point, and only used when illustrative of the surrounding text.
| |
| * ''Style'': code should be properly indented with clear naming and commenting where necessary.
| |
| | |
| == 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:
| |
| | |
| * <code><nowiki>[[Category:NixOS]]</nowiki></code> - articles related to the Nix Operating System, the Module System and the System Configuration.
| |
| * <code><nowiki>[[Category:Nix]]</nowiki></code> - articles about Using the Nix Tools to accomplish great things.
| |
| * <code><nowiki>[[Category:Nixpkgs]]</nowiki></code> - articles about Maintaining code in the Nixpkgs repository, structuring, and so on.
| |
| * <code><nowiki>[[Category:Nix Language]]</nowiki></code> - description of Language quirks and solutions.
| |
| * <code><nowiki>[[Category:NixOps]]</nowiki></code> - the [https://github.com/NixOS/nixops the NixOps tool] and ecosystem.
| |
| * <code><nowiki>[[Category:Hydra]]</nowiki></code> - Hydra continuous Integration related documentation.
| |
| * <code><nowiki>[[Category:Disnix]]</nowiki></code> - for articles about Disnix, the Nix-based microservice architecture.
| |
| | |
| === 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><nowiki>[[Category:Tutorial]]</nowiki></code>
| |
| * is learning-oriented
| |
| * allows the newcomer to get started
| |
| * is a lesson
| |
| | |
| <code><nowiki>[[Category:Discussion]]</nowiki></code>
| |
| * is understanding-oriented
| |
| * explains
| |
| * provides background and context
| |
| | |
| <code><nowiki>[[Category:Guide]]</nowiki></code>
| |
| * is goal-oriented
| |
| * how-to's for dealing with a specific problem / tool
| |
| * is a series of steps
| |
| | |
| <code><nowiki>[[Category:Cookbook]]</nowiki></code>
| |
| * is recipe orientated
| |
| * a collection of short code snippets and hacks
| |
| * arranged around a theme or tool
| |
| | |
| <code><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 ==
| |
| | |
| | |
| * Types of Documentation: https://www.divio.com/en/blog/documentation/
| |
| * Wiki Restructuring Discussion: https://github.com/nixos-users/wiki/issues/3
| |
