Difference between revisions of "Help:Categories for Authors"

From Xen
(Migrated this, such that it can be extended)
 
(Saving (as unwieldly))
Line 1: Line 1:
 +
== Navigation Categories ==
 +
{{Warning|Every page should choose a category from the list in this section, e.g.
 +
<pre>
 +
[[Category:Xen]] [[Category:Developers]] [[Category:HowTo]]</pre>}}
 +
=== Technology/Project Categories ===
 +
{|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: 80%;background-color:#58D3F7;"|'''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.
 +
|}
  
=== Common Categories ===
+
=== Audience Categories ===
 
{|style="vertical-align: top; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
 
{|style="vertical-align: top; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
 
|colspan="2" style="background-color:#38A3C7;"| '''''Categories by audience'''''
 
|colspan="2" style="background-color:#38A3C7;"| '''''Categories by audience'''''
Line 21: Line 44:
 
|[[:Category:Community]]
 
|[[: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
 
|This document is a community document that doesn't fit elsewhere. It is intended for general information of Xen and the community at large
|-
+
|}
|colspan="2" style="background-color:#38A3C7;"| '''''Categories by lifetime'''''
+
 
 +
=== Document Type Categories ===
 +
{|style="vertical-align: top; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
 +
|colspan="2" style="background-color:#38A3C7;"| '''''Categories by document type''''' (note that these should be used in conjunction with audience categories)
 
|-
 
|-
 
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
 
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
 
|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
 
|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
 
|-
 
|-
|[[:Category:Transient]]
+
|[[:Category:Manual]]
|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.
+
|This document man pages or other official documentation.
|-
 
|[[:Category:Archived]]
 
|This document has been archived.
 
|-
 
|colspan="2" style="background-color:#38A3C7;"| '''''Categories by document type''''' (note that these should be used in conjunction with audience categories)
 
|-
 
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
 
|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
 
 
|-
 
|-
 
|[[:Category:Overview]]
 
|[[:Category:Overview]]
Line 61: Line 79:
 
|[[:Category:Glossary]]
 
|[[:Category:Glossary]]
 
|This document is a definition of a term used in the Xen community or more generally.
 
|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 ===
 +
 +
{|style="vertical-align: top; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
 +
|-
 +
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
 +
|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
 
|-
 
|-
|colspan="2" style="background-color:#38A3C7;"| '''''Categories by project or technology'''''
+
|[[:Category:Release Notes]]
 +
|This document describes Release Notes for a specifc project or product hosted on Xen.org.
 +
|}
 +
 
 +
=== Development Related ===
 +
{|style="vertical-align: top; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
 
|-
 
|-
 
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
 
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
 
|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
 
|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
 
|-
 
|-
|[[:Category:Xen]]
+
|[[:Category:Development Process]]
|This document is related to the Xen Hypervisor project or technology. This category may be used for user, developer as well as project categories.
+
|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 [http://en.wikipedia.org/wiki/OCaml OCaml] language, in which most of XCP is implemented.
 +
|}
 +
 
 +
=== Technology Related ===
 +
 
 +
{|style="vertical-align: top; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
 
|-
 
|-
|[[:Category:XCP]]
+
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
|This document is related to the XCP project or technology. This category may be used for user, developer as well as project categories.
+
|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
 
|-
 
|-
|[[:Category:PVOPS]]
+
|[[:Category:Performance]]
|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.
+
|Contains documents and benchmarks related to the performance of Xen, XCP, etc.  
 
|-
 
|-
|[[:Category:XenARM]]
+
|[[:Category:Security]]
|This document is related to the XenARM project or technology. This category may be used for user, developer as well as project categories.
+
|Contains documents related to Xen, XCP, etc. Security
 
|}
 
|}
  
=== Other Categories ===
+
=== Community Related ===
These are more specialised categories. Please ensure that these are used in conjunction with
 
 
{|style="vertical-align: top; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
 
{|style="vertical-align: top; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
|colspan="2" style="background-color:#38A3C7;"| '''''Project type: Categories that relate to a specific [[:Category:Project|project]]'''''
 
 
|-
 
|-
 
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
 
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
 
|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
 
|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
 
|-
 
|-
|[[:Category:OCaml]]
+
|[[:Category:Events]]
|This document is related to the [http://en.wikipedia.org/wiki/OCaml OCaml] language, in which most of XCP is implemented.
+
|Contains documents related to community events
 
|-
 
|-
|colspan="2" style="background-color:#38A3C7;"| '''''Document type: Categories that are mainly relevant to [[:Category:Developers|developers]]'''''
+
|[[:Category:GSoC]]
 +
|Contains documents related to Google Summer of Code
 +
|}
 +
 
 +
== Categories to help manage the Wiki ==
 +
 
 +
=== Content Lifecycle ===
 +
{|style="vertical-align: top; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
 +
|colspan="2" style="background-color:#38A3C7;"| '''''Categories by lifetime'''''
 
|-
 
|-
 
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
 
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
 
|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
 
|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
 
|-
 
|-
|[[:Category:Development Process]]
+
|[[:Category:Transient]]
|This document describes a process or technique relates to projects on Xen.org. Documents in this category are mainly relevant for developers.
+
|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:Design Document]]
+
|[[:Category:Archived]]
|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.
+
|This document has been archived. More on [[Wiki Community#archive|archiving pages]].
|-
+
|}
|colspan="2" style="background-color:#38A3C7;"| '''''Document type: Categories that are mainly relevant to [[:Category:Users|users]]'''''
+
 
 +
=== Related to [[Wiki_Community#templates|Maintenance Templates]] ===
 +
 
 +
{|style="vertical-align: top; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
 +
|colspan="2" style="background-color:#38A3C7;"| '''''Categories by lifetime'''''
 
|-
 
|-
 
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
 
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
 
|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
 
|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
 
|-
 
|-
|[[:Category:Release Notes]]
+
|[[:Category:Contains_Needs_Action|Action Needed]]  
|This document describes Release Notes for a specifc project or product hosted on Xen.org.
+
|Lists pages that needs deletion, refactor, review, ...
 +
|-
 +
|[[:Category:Contains_Needs_Formatting|Needs formatting]]
 +
|Lists pages that contain easy formatting fixes for a beginner
 +
|-
 +
|[[:Category:Contains_TODO|Category:TODO]]
 +
|Lists pages with a TODO note
 +
|-
 +
|[[:Category:Warning|Category:Warning]]
 +
|Lists pages with that contain a [{Template:Warning|Warning]] template
 
|}
 
|}

Revision as of 13:43, 25 June 2012

Navigation Categories

Icon Ambox.png Every page should choose a category from the list in this section, e.g.
[[Category:Xen]] [[Category:Developers]] [[Category:HowTo]]

Technology/Project Categories

Categories by project or technology
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: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