Help:Categories for Authors: Difference between revisions

From Xen
Jump to navigationJump to search
(Migrated this, such that it can be extended)
 
 
(25 intermediate revisions by 3 users not shown)
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>
'''Before you create a new category, please read [[Wiki_Community#Categories]]!'''
}}
=== Technology/Project Categories ===
{| class="sortable" 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'''
|-
|[[: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"
{| 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 audience'''''
|-
|-
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
Line 14: Line 37:
|-
|-
|[[:Category:Developers]]
|[[:Category:Developers]]
|This document is for developers of Xen or any project hosted on Xen.org
|This document is for developers of Xen or any project hosted by the Xen Project. '''Please also see DEVELOPER TEAM CATEGORIES!'''
|-
|-
|[[:Category:Project]]
|[[:Category:Project]]
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'''''
=== Developer Team Categories ===
{| class="sortable" 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:Transient]]
|[[:Category:Developers]]
|This document is owned by developers of the [http://xenproject.org/developers/teams/hypervisor.html Hypervisor subproject]
|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]]
|[[:Category:XenARM]]
|This document is owned by developers of the [http://xenproject.org/developers/teams/arm-hypervisor.html ARM Hypervisor subproject]. ''Note that the page usually also should contain [[:Category:Developers]]'' as the ARM port is being developed as part of the Hypervisor
|This document has been archived.
|-
|-
|[[:Category:Embedded and Automotive]]
|colspan="2" style="background-color:#38A3C7;"| '''''Categories by document type''''' (note that these should be used in conjunction with audience categories)
|This document is owned by developers of the [http://xenproject.org/developers/teams/embedded-and-automotive.html Embedded and Automotive subproject]
|-
|[[:Category:Mirage]]
|This document is owned by developers of the [http://xenproject.org/developers/teams/mirage-os.html Mirage OS subproject].
|-
|[[:Category:Unikraft]]
|This document is owned by developers of the [https://xenproject.org/developers/teams/unikraft Unikraft subproject].
|-
|[[:Category:XAPI Devel]]
|This document is owned by developers of the [http://xenproject.org/developers/teams/xapi.html XAPI subproject]
|-
|[[:Category:PVOPS]]
|This document is owned by developers of the [http://xenproject.org/developers/teams/pvops.html PVOPS subproject]
|-
|[[:Category:Windows PV Drivers]]
|This document is owned by developers of the [http://xenproject.org/developers/teams/windows-pv-drivers.html Windows PV Drivers subproject]
|}

=== Document Type Categories ===
{| class="sortable" 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: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]]
|[[:Category:Overview]]
Line 61: Line 112:
|[[: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 ===
{|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: 80%;background-color:#58D3F7;"|'''When to use'''
|-
|[[:Category:Host Install]]
|Documents related to installing Xen on a host
|-
|[[:Category:Guest Install]]
|Documents related to installing guests on Xen
|-
|[[:Category:Host Configuration]]
|Documents related to bootloader, console and network configuration
|}

=== Linux/Unix Distribution Related ===
{|class="sortable" 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:Arch Linux]]
|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:Alpine Linux]]
* [[:Category:CentOS]]
* [[:Category:Debian]]
* [[:Category:Fedora]]
* [[:Category:FreeBSD]]
* [[:Category:Finnix]]
* [[:Category:Gentoo]]
* [[:Category:Funtoo]]
* [[:Category:NetBSD]]
* [[:Category:Oracle Linux]]
* [[:Category:OpenIndiana]]
* [[:Category:OpenSuSe]]
* [[:Category:RHEL]]
* [[:Category:Solaris]]
* [[:Category:Ubuntu]]
|Categories related to Linux/Unix distro (active distros)
|}

=== Cloud Related ===
{|class="sortable" style="vertical-align: top; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
|-
|-
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
|[[:Category:XCP]]
|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
|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]]
|[[:Category:CloudStack]]
|Documents related to CloudStack integration
|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]]
|[[:Category:OpenStack]]
|Documents related to OpenStack integration
|This document is related to the XenARM project or technology. This category may be used for user, developer as well as project categories.
|}
|}


=== Other Categories ===
=== Release 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"
{|class="sortable" 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:Xen 4.2]]
|This document is related to the [http://en.wikipedia.org/wiki/OCaml OCaml] language, in which most of XCP is implemented.
|This document contains articles related to Xen 4.2 features, planning, etc.
|-
|-
|[[:Category:Xen 4.3]]
|colspan="2" style="background-color:#38A3C7;"| '''''Document type: Categories that are mainly relevant to [[:Category:Developers|developers]]'''''
|This document contains articles related to Xen 4.3 features, planning, etc.
|-
|[[:Category:Xen 4.4]]
|This document contains articles related to Xen 4.4 features, planning, etc.
|-
|[[:Category:Xen 4.5]]
|This document contains articles related to Xen 4.5 features, planning, etc.
|-
|[[:Category:Xen 4.6]]
|This document contains articles related to Xen 4.6 features, planning, etc.
|-
|[[:Category:Release Notes]]
|This document describes Release Notes for a specifc project or product hosted on Xen.org.
|}

=== Development Related ===
{|class="sortable" 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'''
Line 98: Line 204:
|[[:Category:Development Process]]
|[[: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.
|This document describes a process or technique relates to projects on Xen.org. Documents in this category are mainly relevant for developers.
|-
|[[:Category:Testing]]
|This document is related to testing.
|-
|-
|[[:Category:Design Document]]
|[[: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.
|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]]
|colspan="2" style="background-color:#38A3C7;"| '''''Document type: Categories that are mainly relevant to [[:Category:Users|users]]'''''
|This document is related to the [http://en.wikipedia.org/wiki/OCaml OCaml] language, in which most of XCP is implemented.
|}

=== Technology Related ===

{|class="sortable" 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:Release Notes]]
|[[:Category:Kernel]]
|Contains documents related to kernel technologies
|This document describes Release Notes for a specifc project or product hosted on Xen.org.
|-
|[[:Category:NUMA]]
|This category contains all articles related to the running (or to improving the support for doing so) of the Xen Hypervisor on NUMA architectures
|-
|[[:Category:Performance]]
|Contains documents and benchmarks related to the performance of Xen, XCP, etc.
|-
|[[:Category:Security]]
|Contains documents related to Xen, XCP, etc. Security
|-
|[[:Category:VGA]]
|Contains documents related to VGA, VTd, etc.
|-
|[[:Category:XCI]]
|Contains documents related to XCI aka the Xen Client Initiative
|}
|}

=== Community Related ===
{|class="sortable" 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'''
|-
|[[:Category:Events]]
|Contains documents related to community events
|-
|[[:Category:GSoC]]
|Contains documents related to Google Summer of Code
|-
|[[:Category:Wiki Management]]
|Contains documents related to managing the Xen Wiki
|}

== Categories to help manage the Wiki ==

=== Content Lifecycle ===
{|class="sortable" 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'''
|-
|[[: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 [[Wiki Community#archive|archiving pages]].
|}

=== Related to [[Wiki_Community#templates|Maintenance Templates]] ===

{|class="sortable" 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'''
|-
|[[:Category:Contains_Needs_Action|Action Needed]]
|Lists pages that needs deletion, refactor, review, ...
|-
|[[:Category:Contains_Needs_Formatting|Needs formatting]]
|Lists pages that contain easy formatting fixes for a beginner
|-
|[[:Category:RefToExternalArticle|RefToExternalArticle]]
|Lists pages that are a stub for an external article
|-
|[[:Category:Trail|Category:Trail]]
|Lists pages with that contain a [[Template:Trail|Trail]] template
|-
|[[: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
|}

[[Category:Wiki Management]]

Latest revision as of 17:07, 14 May 2019

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]]

Before you create a new category, please read Wiki_Community#Categories!

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

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 by the Xen Project. Please also see DEVELOPER TEAM CATEGORIES!
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

Developer Team Categories

Category When to use
Category:Developers This document is owned by developers of the Hypervisor subproject
Category:XenARM This document is owned by developers of the ARM Hypervisor subproject. Note that the page usually also should contain Category:Developers as the ARM port is being developed as part of the Hypervisor
Category:Embedded and Automotive This document is owned by developers of the Embedded and Automotive subproject
Category:Mirage This document is owned by developers of the Mirage OS subproject.
Category:Unikraft This document is owned by developers of the Unikraft subproject.
Category:XAPI Devel This document is owned by developers of the XAPI subproject
Category:PVOPS This document is owned by developers of the PVOPS subproject
Category:Windows PV Drivers This document is owned by developers of the Windows PV Drivers subproject

Document Type 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 When to use
Category:Host Install Documents related to installing Xen on a host
Category:Guest Install Documents related to installing guests on Xen
Category:Host Configuration Documents related to bootloader, console and network configuration

Linux/Unix Distribution Related

Category When to use
Categories related to Linux/Unix distro (active distros)

Cloud Related

Category When to use
Category:CloudStack Documents related to CloudStack integration
Category:OpenStack Documents related to OpenStack integration

Release Related

Category When to use
Category:Xen 4.2 This document contains articles related to Xen 4.2 features, planning, etc.
Category:Xen 4.3 This document contains articles related to Xen 4.3 features, planning, etc.
Category:Xen 4.4 This document contains articles related to Xen 4.4 features, planning, etc.
Category:Xen 4.5 This document contains articles related to Xen 4.5 features, planning, etc.
Category:Xen 4.6 This document contains articles related to Xen 4.6 features, planning, etc.
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:Testing This document is related to testing.
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:Kernel Contains documents related to kernel technologies
Category:NUMA This category contains all articles related to the running (or to improving the support for doing so) of the Xen Hypervisor on NUMA architectures
Category:Performance Contains documents and benchmarks related to the performance of Xen, XCP, etc.
Category:Security Contains documents related to Xen, XCP, etc. Security
Category:VGA Contains documents related to VGA, VTd, etc.
Category:XCI Contains documents related to XCI aka the Xen Client Initiative

Community Related

Category When to use
Category:Events Contains documents related to community events
Category:GSoC Contains documents related to Google Summer of Code
Category:Wiki Management Contains documents related to managing the Xen Wiki

Categories to help manage the Wiki

Content Lifecycle

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

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
RefToExternalArticle Lists pages that are a stub for an external article
Category:Trail Lists pages with that contain a Trail template
Category:TODO Lists pages with a TODO note
Category:Warning Lists pages with that contain a Warning template
Retrieved from "https://wiki.xenproject.org/index.php?title=Help:Categories_for_Authors&oldid=19310"