ironic/doc/source/admin/operation.rst
Dmitry Tantsur 656f93b6e7
Reorganize the documentation front page
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

25 lines
757 B
ReStructuredText

Configuration and Operation
===========================
.. toctree::
:maxdepth: 1
Ironic Python Agent <drivers/ipa>
Multi-tenant Networking <multitenancy>
Port Groups <portgroups>
Conductor Groups <conductor-groups>
Security <security>
Troubleshooting FAQ <troubleshooting>
Power Synchronization <power-sync>
Fast-Track Deployment <fast-track>
Authentication for Instance Images <user-image-basic-auth>
OVN Networking <ovn-networking>
Ceph Object Gateway <radosgw>
Emitting Software Metrics <metrics>
Auditing API Traffic <api-audit-support>
Service State Reporting <gmr>
Tuning Ironic <tuning>
Role Based Access Control <secure-rbac>
Dashboard Integration <dashboard>
Upgrade Guide <upgrade-guide>