Index Guide

Navigation and Top Level Indexes

Navigation by category

Our wiki categorizes pages strictly. This means, that you can use categories to navigate through content. Note that ...

• Our category pages are not normally just indexes, but frequently have a hand-edited header, which highlight important information.
• All documents are in one of these three categories: this makes it possible to browse
• These categories are exposed in the sidebar
• Note that these categories can be rather big!

Audience

• Beginners of Xen Project, XAPI, etc.
• Users of Xen Project, XAPI, etc.
• Developers of Xen Project, XAPI, etc.
• Project (for project teams; general project info)
• Community (general community documents)

Document Type

• Manuals contains official Xen Project documentation
• ManPage contains This section contains link to Xen Project manual pages that are generated from the Xen Project codebase
• Overviews contains overview documents
• FAQs contains Xen Project, XAPI, ... FAQs sorted by topic
• HowTos contains Xen Project, XAPI, ... How To documents
• Tutorials contains Xen Project, XAPI, ... tutorials
• Example contains Xen Project, XAPI, ... examples
• Compatibility contains information on compatibility
• Glossary pages and definitions
• Index Pages are lists of pages that are not categories

Technology

Hypervisor and Linux:

• Xen Hypervisor - All Xen Project Hypervisor docs (not yet manually maintained)
• Xen ARM - All Xen Project ARM docs
• PVOPS (Xen in Linux) - All PVOPS docs

Unikernels:

• Unikernels - Information related to various unikernels
• Unikraft - Unikraft is an SDK for building unikernels
• MiniOS - MiniOS is a minimal operating system used in a Xen stack. It is also often used in the context of unikernels
• Mirage - Mirage OS is a unikernel

Drivers:

Toolstacks:

• Libvirt - All libvirt docs
• XAPI - All XAPI docs

Indexes for Specific Uses

Release Related

• Category:Release Notes contain Xen release notes
• Category:Xen 4.4 contain articles related to Xen 4.4 features, benchmarks, planning, etc.

Installation Related

• Category:Host Install contains documents related to installing Xen Project software on a host
• Category:Guest Install contains Documents related to installing guests on a Xen Project hypervisor
• Category:Host Configuration contains documents related to bootloader, console and network configuration

Linux/Unix Distribution Related

Categories related to Linux/Unix distro. Typically contain tutorials, install info, etc. for a specific distro.

• Category:Arch Linux
• Category:Alpine Linux
• Category:CentOS
• Category:Debian
• Category:Fedora
• Category:FreeBSD
• Category:Finnix
• Category:Gentoo
• Category:NetBSD
• Category:Oracle Linux
• Category:OpenBSD
• Category:OpenEmbedded
• Category:OpenIndiana
• Category:OpenSuSE
• Category:RHEL
• Category:Solaris
• Category:Yocto
• Category:Ubuntu

Cloud Related

Categories related to Xen Project integration with cloud stacks

• Category:CloudStack
• Category:OpenStack
• Category:Integration
• Category:Unikernels

Technology Related (Networking, Performance, Security, NUMA, VGA, ...)

Specialist topics on Xen Project software:

• Category:Networking contains articles related to networking
• Category:NUMA contains all articles related to the running (or to improving the support for doing so) of the Xen Project Hypervisor on NUMA architectures
• Category:Performance contains documents, tuning instructions and benchmarks related to the performance of Xen Project, etc.
• Category:Security contains documents related to Xen Project, etc. security
• Category:VGA contains documents related to VGA, VTd, GPY passthrough, etc.
• Category:XCI contains documents related to XCI aka the Xen Client Initiative

Development Related

These contain categories for developers:

• Category:Development Process describes development processes, governance, etc..
• Category:Design Document 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 related to the OCaml language, in which most of XAPI is implemented.

Community Related

• Category:GSoC contains documents related to Google Summer of Code
• Category:Events contains information related to events

Contributing to the Wiki

• Help:Contents Wiki help
• Category:Templates description of frequently used templates
• Category:Wiki Management contains documents related to managing the Xen Wiki