This is largely inspired by the excellent feedback we got from David
Welsch, although this patch is only a very early first step towards
where we want to be with the documentation.

First, I'm splitting the large administrator guide into several large
sections: features, operation, architecture. Some of their topic might
actually find a better home outside of the administrator guide, but I
don't go that far in this change.

Second, I'm grouping several separate things together with the larger
topics:
- API topics are relevant for users and are grouped with the user guide
- Configuration guide and release notes are grouped with the
  administrator guide.
- The command reference is renamed for clarity and also grouped with the
  administrator guide since these are not user-visible commands.
- I'm dropping the "Advanced topics" subsection. While I like its
  intention (and I think it was me who added it in the first place),
  it's clear that such separation makes these topics much less
  discoverable.

Third, I'm playing with :maxdepth: here to make the sub-pages more
informative.

Change-Id: Icd0a35b252136b7da107c6346c48473cf1b99bcb

2024-06-24 13:25:51 +02:00

867 B

Raw Blame History

Bare Metal Service Features

Hardware Inspection <inspection> Deployment <node-deployment> Cleaning <cleaning> Adoption <adoption> Retirement <retirement> RAID Configuration <raid> BIOS Settings <bios> Firmware Updates <firmware-updates> Node Rescuing <rescue> Booting from Volume <boot-from-volume> Configuring Web or Serial Console <console> Enabling Notifications <notifications> Node Multi-Tenancy <node-multitenancy> Booting a Ramdisk or an ISO <ramdisk-boot> Hardware Burn-in <hardware-burn-in> Vendor Passthru <vendor-passthru> Servicing <servicing> Windows Images <building-windows-images> Deploying without BMC Credentials <agent-power> Layer 3 or DHCP-less Ramdisk Booting <dhcp-less> Deploying with Anaconda <anaconda-deploy-interface>

867 B Raw Blame History

Bare Metal Service Features

867 B

Raw Blame History