Jump to content

NixOS Wiki:Contributing: Difference between revisions

imported>Ixxie
imported>Ixxie
Line 48: Line 48:
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:


* <pre>[[Category:Tutorial]]</pre>
<code><nowiki>[[Category:Tutorial]]</nowiki></code>
** is learning-oriented
* is learning-oriented
** allows the newcomer to get started
* allows the newcomer to get started
** is a lesson
* is a lesson


* <pre>[[Category:Discussion]]</pre>
<code><nowiki>[[Category:Discussion]]</nowiki></code>
** is understanding-oriented
* is understanding-oriented
** explains  
* explains  
** provides background and context
* provides background and context


* <pre>[[Category:Guide]]</pre>
<code><nowiki>[[Category:Guide]]</nowiki></code>
** is goal-oriented
* is goal-oriented
** how-to's for dealing with a specific problem / tool
* how-to's for dealing with a specific problem / tool
** is a series of steps
* is a series of steps


* <pre>[[Category:Cookbook]]</pre>
<code><nowiki>[[Category:Cookbook]]</nowiki></code>
** is recipe orientated
* is recipe orientated
** a collection of short code snippets and hacks  
* a collection of short code snippets and hacks  
** arranged around a theme or tool
* arranged around a theme or tool


* <pre>[[Category:Reference]]</pre>
<code><nowiki>[[Category:Reference]]</nowiki></code>
** is information-oriented
* is information-oriented
** describes the machinery
* describes the machinery
** is accurate and complete
* is accurate and complete
** Most of the time the nixos-wiki will not contain reference documents
* Most of the time the nixos-wiki will not contain reference documents


== References ==
== References ==
Anonymous user