Help:Categories for Authors: Difference between revisions
From Xen
Jump to navigationJump to search
Lars.kurth (talk | contribs) |
Lars.kurth (talk | contribs) m (Sortable) |
||
| Line 4: | Line 4: | ||
[[Category:Xen]] [[Category:Developers]] [[Category:HowTo]]</pre>}} |
[[Category:Xen]] [[Category:Developers]] [[Category:HowTo]]</pre>}} |
||
=== Technology/Project Categories === |
=== Technology/Project Categories === |
||
{|style="vertical-align: top; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000" |
{| class="sortable" style="vertical-align: top; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000" |
||
|colspan="2" style="background-color:#38A3C7;"| '''''Categories by project or technology''''' |
|||
|- |
|- |
||
|style="width: 20%;background-color:#58D3F7;"|'''Category''' |
|style="width: 20%;background-color:#58D3F7;"|'''Category''' |
||
Revision as of 13:45, 25 June 2012
|
Every page should choose a category from the list in this section, e.g.
[[Category:Xen]] [[Category:Developers]] [[Category:HowTo]] |
Technology/Project Categories
| Category | When to use |
| Category:Xen | This document is related to the Xen Hypervisor project or technology. This category may be used for user, developer as well as project categories. |
| Category:XCP | This document is related to the XCP project or technology. This category may be used for user, developer as well as project categories. |
| Category:PVOPS | This document is related to the PVOPS project or technology, which is about upstreaming and maintining Xen support in Linux. This category may be used for user, developer as well as project categories. |
| Category:XenARM | This document is related to the XenARM project or technology. This category may be used for user, developer as well as project categories. |
Audience Categories
| Categories by audience | |
| Category | When to use |
| Category:Users | This document is for users of Xen or any project hosted on Xen.org |
| Category:Beginners | This document is primarily targeted at beginners. Note that this category should primarily be used together with Category:Users. |
| Category:Developers | This document is for developers of Xen or any project hosted on Xen.org |
| Category:Project | This document is primarily a project document such as a roadmap, TODO list, minutes, etc. for a project hosted on Xen.org |
| Category:Community | This document is a community document that doesn't fit elsewhere. It is intended for general information of Xen and the community at large |
Document Type Categories
| Categories by document type (note that these should be used in conjunction with audience categories) | |
| Category | When to use |
| Category:Manual | This document man pages or other official documentation. |
| Category:ManPage | This document is a man page - a document in this category should also be in Category:Manual. |
| Category:Overview | This document contains an Overview document for a specific topic. Overviews are typically introductory and contain definitions, trade-offs, basic concepts, etc. |
| Category:FAQ | This document contains one or several frequently asked questions including answers |
| Category:HowTo | This document contains a HowTo document, which usually is a short tutorial |
| Category:Tutorial | This document contains a step-by-step tutorial for a fairly complex use-case |
| Category:Example | This document primarily contains example configuration files, settings, scripts, etc. |
| Category:Compatibility | This document contains a information about software - software, software - hardware and other compatibility. |
| Category:Index | This document is largely an index to other pages. |
| Category:Glossary | This document is a definition of a term used in the Xen community or more generally. |
Categories that are useful in the certain situations
Installation Related
Category:Host_Configuration
Linux/Unix Distribution Related
Cloud Related
Release Related
| Category | When to use |
| Category:Release Notes | This document describes Release Notes for a specifc project or product hosted on Xen.org. |
Development Related
| Category | When to use |
| Category:Development Process | This document describes a process or technique relates to projects on Xen.org. Documents in this category are mainly relevant for developers. |
| Category:Design Document | This category contains design documents, architecture descriptions, and so on: in short it contains documents that describe how parts of the codebase work. Documents in this category are mainly relevant for developers. |
| Category:OCaml | This document is related to the OCaml language, in which most of XCP is implemented. |
Technology Related
| Category | When to use |
| Category:Performance | Contains documents and benchmarks related to the performance of Xen, XCP, etc. |
| Category:Security | Contains documents related to Xen, XCP, etc. Security |
Community Related
| Category | When to use |
| Category:Events | Contains documents related to community events |
| Category:GSoC | Contains documents related to Google Summer of Code |
Categories to help manage the Wiki
Content Lifecycle
| Categories by lifetime | |
| Category | When to use |
| Category:Transient | This document has a limited lifespan (e.g. it describes an event or a short-lived activity). Pages in this category should be reviewed at least annually and archived appropriately. |
| Category:Archived | This document has been archived. More on archiving pages. |
Related to Maintenance Templates
| Categories by lifetime | |
| Category | When to use |
| Action Needed | Lists pages that needs deletion, refactor, review, ... |
| Needs formatting | Lists pages that contain easy formatting fixes for a beginner |
| Category:TODO | Lists pages with a TODO note |
| Category:Warning | Warning]] template |
