Rework the navigation in the contributor guide

The goal here is to give newcomers an easier overview of the contributor
guide. Currently, the index page only points at a couple of sections in
the contributor index, which may be confusing. So:

1) Expand the contributor reference from the index page one more level.
2) Update headings in the contributor guide to match the toctrees and
   their expected level.
3) Expand toctrees in the contributor index one more level.
4) Move references to the development enviroment to a higher level
   toctree to make them visible in the index.
5) Apply consistent upper case heading.

Change-Id: Ifb9fdc96b368095437771217090120e83eaa0fa7

2024-06-24 13:24:54 +02:00

2.5 KiB

Raw Blame History

Welcome to Ironic's documentation!

Introduction

Ironic is an OpenStack project which provisions bare metal (as opposed to virtual) machines. It may be used independently or as part of an OpenStack Cloud, and integrates with the OpenStack Identity (keystone), Compute (nova), Network (neutron), Image (glance), and Object (swift) services.

The Bare Metal service manages hardware through both common (eg. PXE and IPMI) and vendor-specific remote management protocols. It provides the cloud operator with a unified interface to a heterogeneous fleet of servers while also providing the Compute service with an interface that allows physical servers to be managed as though they were virtual machines.

This documentation is continually updated and may not represent the state of the project at any specific prior release. To access documentation for a previous release of ironic, append the OpenStack release name to the URL; for example, the ocata release is available at https://docs.openstack.org/ironic/ocata/.

Found a bug in one of our projects? Please see /contributor/bugs.

Would like to engage with the community? See /contributor/community.

Installation Guide

install/index install/standalone admin/upgrade-guide

User Guide

user/index

Administrator Guide

admin/drivers

admin/index

Configuration Guide

configuration/index

Bare Metal API References

Ironic's REST API has changed since its first release, and continues to evolve to meet the changing needs of the community. Here we provide a conceptual guide as well as more detailed reference documentation.

API Concept Guide <contributor/webapi> API Reference (latest) <https://docs.openstack.org/api-ref/baremetal/> API Version History <contributor/webapi-version-history>

Command References

Here are references for commands not elsewhere documented.

cli/index

Contributor Guide

contributor/index

Release Notes

html

Indices and tables

genindex
search

2.5 KiB Raw Blame History