Help:Categories for Authors
From Xen
Jump to navigationJump to search
Common 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 |
| 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. |
| Categories by document type (note that these should be used in conjunction with audience categories) | |
| Category | When to use |
| 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 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. |
Other Categories
These are more specialised categories. Please ensure that these are used in conjunction with
| Project type: Categories that relate to a specific project | |
| Category | When to use |
| Category:OCaml | This document is related to the OCaml language, in which most of XCP is implemented. |
| Document type: Categories that are mainly relevant to developers | |
| 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. |
| Document type: Categories that are mainly relevant to users | |
| Category | When to use |
| Category:Release Notes | This document describes Release Notes for a specifc project or product hosted on Xen.org. |
