Index Guide: Difference between revisions

From Xen
Jump to navigationJump to search
No edit summary
 
(23 intermediate revisions by 3 users not shown)
Line 25: Line 25:


=== Audience ===
=== Audience ===
* [[:Category:Beginners|Beginners]] of Xen, XCP, etc.
* [[:Category:Beginners|Beginners]] of Xen Project, XAPI, etc.
* [[:Category:Users|Users]] of Xen, XCP, etc.
* [[:Category:Users|Users]] of Xen Project, XAPI, etc.
* [[:Category:Developers|Developers]] of Xen, XCP, etc.
* [[:Category:Developers|Developers]] of Xen Project, XAPI, etc.
* [[:Category:Project|Project]] (for project teams; general project info)
* [[:Category:Project|Project]] (for project teams; general project info)
* [[:Category:Community|Community]] (general community documents)
* [[:Category:Community|Community]] (general community documents)


=== Document Type ===
=== Document Type ===
* [[:Category:Manual|Manuals]] contains official Xen documentation
* [[:Category:Manual|Manuals]] contains official Xen Project documentation
* [[:Category:ManPage|ManPage]] contains This section contains link to Xen manual pages that are generated from the Xen codebase
* [[:Category:ManPage|ManPage]] contains This section contains link to Xen Project manual pages that are generated from the Xen Project codebase
* [[:Category:Overview|Overviews]] contains overview documents
* [[:Category:Overview|Overviews]] contains overview documents
* [[:Category:FAQ|FAQs]] contains Xen, XCP, ... FAQs sorted by topic
* [[:Category:FAQ|FAQs]] contains Xen Project, XAPI, ... FAQs sorted by topic
* [[:Category:HowTo|HowTos]] contains Xen, XCP, ... How To documents
* [[:Category:HowTo|HowTos]] contains Xen Project, XAPI, ... How To documents
* [[:Category:Tutorial|Tutorials]] contains Xen, XCP, ... tutorials
* [[:Category:Tutorial|Tutorials]] contains Xen Project, XAPI, ... tutorials
* [[:Category:Example|Example]] contains Xen, XCP, ... examples
* [[:Category:Example|Example]] contains Xen Project, XAPI, ... examples
* [[:Category:Compatibility|Compatibility]] contains information on compatibility
* [[:Category:Compatibility|Compatibility]] contains information on compatibility
* [[:Category:Glossary|Glossary]] pages and definitions
* [[:Category:Glossary|Glossary]] pages and definitions
Line 44: Line 44:


=== Technology ===
=== Technology ===
'''Hypervisor and Linux''':
* [[:Category:Xen|Xen Hypervisor]] - All Xen Hypervisor docs (not yet manually maintained)
* [[:Category:XCP|XCP]] - All XCP docs
* [[:Category:Xen|Xen Hypervisor]] - All Xen Project Hypervisor docs (not yet manually maintained)
* [[:Category:XenARM|Xen ARM]] - All Xen ARM docs
* [[:Category:XenARM|Xen ARM]] - All Xen Project ARM docs
* [[:Category:PVOPS|PVOPS (Xen in Linux)]] - All PVOPS docs
* [[:Category:PVOPS|PVOPS (Xen in Linux)]] - All PVOPS docs

'''Drivers''':
* [[:Category:Drivers|Drivers]] - Pages related to Linux, Windows and other drivers

'''Unikernels''':
* [[:Category:Unikernels|Unikernels]] - Information related to various unikernels
* [[:Category:Unikraft|Unikraft]] - Unikraft is an SDK for building unikernels
* [[:Category:Minios|MiniOS]] - MiniOS is a minimal operating system used in a Xen stack. It is also often used in the context of unikernels
* [[:Category:Mirage|Mirage]] - Mirage OS is a unikernel

'''Toolstacks''':
* [[:Category:Libvirt|Libvirt]] - All libvirt docs
* [[:Category:XAPI|XAPI]] - All XAPI docs


== Indexes for Specific Uses ==
== Indexes for Specific Uses ==
=== Release Related ===
=== Release Related ===
* [[:Category:Release Notes]] contain Xen release notes
* [[:Category:Release Notes]] contain Xen release notes
* [[:Category:Xen 4.2]] contain articles related to Xen 4.2 features, benchmarks, planning, etc.
* [[:Category:Xen 4.4]] contain articles related to Xen 4.4 features, benchmarks, planning, etc.

=== Installation Related ===
=== Installation Related ===
* [[:Category:Host Install]] contains documents related to installing Xen on a host
* [[:Category:Host Install]] contains documents related to installing Xen Project software on a host
* [[:Category:Guest Install]] contains Documents related to installing guests on Xen
* [[: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
* [[:Category:Host Configuration]] contains documents related to bootloader, console and network configuration

=== Linux/Unix Distribution Related ===
=== Linux/Unix Distribution Related ===
Categories related to Linux/Unix distro. Typically contain tutorials, install info, etc. for a specific distro.
Categories related to Linux/Unix distro. Typically contain tutorials, install info, etc. for a specific distro.
Line 69: Line 84:
* [[:Category:NetBSD]]
* [[:Category:NetBSD]]
* [[:Category:Oracle Linux]]
* [[:Category:Oracle Linux]]
* [[:Category:OpenBSD]]
* [[:Category:OpenEmbedded]]
* [[:Category:OpenIndiana]]
* [[:Category:OpenIndiana]]
* [[:Category:OpenSuSE]]
* [[:Category:OpenSuSE]]
* [[:Category:RHEL]]
* [[:Category:RHEL]]
* [[:Category:Solaris]]
* [[:Category:Solaris]]
* [[:Category:Yocto]]
* [[:Category:Ubuntu]]
* [[:Category:Ubuntu]]


=== Cloud Related ===
=== Cloud Related ===
Categories related to Xen/XCP integration with cloud stacks
Categories related to Xen Project integration with cloud stacks
* [[:Category:CloudStack]]
* [[:Category:CloudStack]]
* [[:Category:OpenStack]]
* [[:Category:OpenStack]]
* [[:Category:Integration]]
* [[:Category:Unikernels]]

=== Technology Related (Networking, Performance, Security, NUMA, VGA, ...) ===
=== Technology Related (Networking, Performance, Security, NUMA, VGA, ...) ===
Specialist topics on Xen:
Specialist topics on Xen Project software:
* [[:Category:Networking]] contains articles related to networking
* [[: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 Hypervisor on NUMA architectures
* [[: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, XCP, etc.
* [[:Category:Performance]] contains documents, tuning instructions and benchmarks related to the performance of Xen Project, etc.
* [[:Category:Security]] contains documents related to Xen, XCP, etc. security
* [[:Category:Security]] contains documents related to Xen Project, etc. security
* [[:Category:VGA]] contains documents related to VGA, VTd, GPY passthrough, etc.
* [[:Category:VGA]] contains documents related to VGA, VTd, GPY passthrough, etc.
* [[:Category:XCI]] contains documents related to XCI aka the Xen Client Initiative
* [[:Category:XCI]] contains documents related to XCI aka the Xen Client Initiative
Line 92: Line 113:
* [[:Category:Development Process]] describes development processes, governance, etc..
* [[: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: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 [http://en.wikipedia.org/wiki/OCaml OCaml] language, in which most of XCP is implemented.
* [[:Category:OCaml]] related to the [http://en.wikipedia.org/wiki/OCaml OCaml] language, in which most of XAPI is implemented.


=== Community Related ===
=== Community Related ===
Line 98: Line 119:
* [[:Category:Events]] contains information related to events
* [[:Category:Events]] contains information related to events


== Wiki Categories ==
== Contributing to the Wiki ==
* [[Help:Contents]] Wiki help
* [[:Category:Templates]] description of frequently used templates
* [[:Category:Templates]] description of frequently used templates
* [[:Category:Wiki Management]] contains documents related to managing the Xen Wiki
* [[:Category:Wiki Management]] contains documents related to managing the Xen Wiki

Latest revision as of 13:12, 7 February 2018

Special Pages
All Categories
All Pages
Recent Changes
Also See
Wiki Guide
v · d · e

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

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:

Drivers:

  • Drivers - Pages related to Linux, Windows and other drivers

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

Toolstacks:

Indexes for Specific Uses

Release Related

Installation Related

Linux/Unix Distribution Related

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

Cloud Related

Categories related to Xen Project integration with cloud stacks

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

Contributing to the Wiki

Retrieved from "https://wiki.xenproject.org/index.php?title=Index_Guide&oldid=18586"