2
0
mirror of https://github.com/xcat2/xcat-core.git synced 2026-10-02 00:41:42 +00:00
Files
xcat-core/docs
Daniel Hilst a5df79078d docs(xcat-core): the support matrix names hypervisors where it must name architectures
The Operating System & Hardware Support Matrix carried eight hardware columns:
Power, Power LE, zVM, Power KVM, x86_64, x86_64 KVM, x86_64 Esxi and riscv64.
Six of them name a platform or a hypervisor, not a build target. xCAT builds and
ships one set of packages per architecture, so a reader cannot tell from the old
table which artifact serves a cell, and the same artifact appears under three
headings.

Reduce the columns to the three architectures xCAT builds for: x86_64, ppc64le
and riscv64. The x86_64, x86_64 KVM and x86_64 Esxi cells collapse into x86_64,
and Power, Power LE and Power KVM collapse into ppc64le. Every collapsed group
held one value per row, so no row changes meaning. The zVM column is removed:
s390x is not a built architecture.

Signed-off-by: Daniel Hilst <392820+dhilst@users.noreply.github.com>
2026-09-11 21:07:45 -03:00
..
2024-02-13 03:01:02 +01:00

Welcome to the xCAT documentation

The xCAT docs are hosted here: https://xcat-docs.readthedocs.io/ and are written in reStructuredText (.rst).

Building Docs

  • Clone this project

  • Install dependencies (See: https://pip.readthedocs.io/)

    pip install --user -r requirements.txt
    
  • Build the Docs

    cd xcat-core/docs
    make html
    
  • View the documentation by pointing a browser to: xcat-core/docs/build/html/index.html