From d3c7e6fad40eb153bdf6c8c0aca4ac6c1b7ba2c1 Mon Sep 17 00:00:00 2001 From: Vladyslav Drok Date: Fri, 3 Jun 2016 20:25:54 +0300 Subject: [PATCH] Fix markup in documentation This change fixes all the markup issues in our docs, such as: * Title length must match an underline (some titles are only 3 characters long, make them longer, otherwise they are not considered a title); * Blank line required after literal block; * Duplicate explicit target name. It also makes section names consistent in drivers.rst. Change-Id: I058224589f4ca63a4acfb8e2c4fcdbb51c730542 --- doc/source/deploy/drivers.rst | 30 +++++------ doc/source/deploy/install-guide.rst | 1 - doc/source/deploy/raid.rst | 1 + doc/source/deploy/upgrade-guide.rst | 4 +- doc/source/deploy/user-guide.rst | 77 ++++++++++++++--------------- doc/source/dev/contributing.rst | 12 ++--- doc/source/dev/dev-quickstart.rst | 1 + doc/source/drivers/ilo.rst | 3 +- doc/source/drivers/ipa.rst | 1 + doc/source/drivers/oneview.rst | 2 +- doc/source/webapi/v1.rst | 6 +-- 11 files changed, 69 insertions(+), 69 deletions(-) diff --git a/doc/source/deploy/drivers.rst b/doc/source/deploy/drivers.rst index ce11527777..4e74f5d087 100644 --- a/doc/source/deploy/drivers.rst +++ b/doc/source/deploy/drivers.rst @@ -1,8 +1,8 @@ .. _drivers: -================= +================ Enabling drivers -================= +================ Ironic-Python-Agent (agent) --------------------------- @@ -13,16 +13,16 @@ nodes, and runs processes inside of a ramdisk. For more information on this, see :ref:`IPA`. -IPMITool --------- +IPMITool driver +--------------- .. toctree:: :maxdepth: 1 ../drivers/ipmitool -DRAC ----- +DRAC driver +----------- DRAC with PXE deploy ^^^^^^^^^^^^^^^^^^^^ @@ -31,16 +31,16 @@ DRAC with PXE deploy ``/etc/ironic/ironic.conf`` - Install python-dracclient package -AMT ----- +AMT driver +---------- .. toctree:: :maxdepth: 1 ../drivers/amt -SNMP ----- +SNMP driver +----------- .. toctree:: :maxdepth: 1 @@ -63,16 +63,16 @@ SeaMicro driver ../drivers/seamicro -iRMC ----- +iRMC driver +----------- .. toctree:: :maxdepth: 1 ../drivers/irmc -VirtualBox drivers ------------------- +VirtualBox driver +----------------- .. toctree:: :maxdepth: 1 @@ -108,7 +108,7 @@ iBoot driver CIMC driver ------------- +----------- .. toctree:: :maxdepth: 1 diff --git a/doc/source/deploy/install-guide.rst b/doc/source/deploy/install-guide.rst index ae1d94d0ca..4c62a39835 100644 --- a/doc/source/deploy/install-guide.rst +++ b/doc/source/deploy/install-guide.rst @@ -2588,5 +2588,4 @@ following command. $ ironic node-set-maintenance $NODE_UUID off -.. _diskimage-builder: http://docs.openstack.org/developer/diskimage-builder/ .. _ironic-python-agent: http://docs.openstack.org/developer/ironic-python-agent/ diff --git a/doc/source/deploy/raid.rst b/doc/source/deploy/raid.rst index 1cf7372a16..158f64fe8f 100644 --- a/doc/source/deploy/raid.rst +++ b/doc/source/deploy/raid.rst @@ -337,3 +337,4 @@ The hardware manager that supports RAID configuration should do the following: {'step': 'delete_configuration', 'interface': 'raid', 'priority': 0}] + diff --git a/doc/source/deploy/upgrade-guide.rst b/doc/source/deploy/upgrade-guide.rst index e38b2e016b..493dcda169 100644 --- a/doc/source/deploy/upgrade-guide.rst +++ b/doc/source/deploy/upgrade-guide.rst @@ -1,8 +1,8 @@ .. _upgrade-guide: -===================================== +================================ Bare Metal Service Upgrade Guide -===================================== +================================ This document outlines various steps and notes for operators to consider when upgrading their Ironic-driven clouds from previous versions of OpenStack. diff --git a/doc/source/deploy/user-guide.rst b/doc/source/deploy/user-guide.rst index 9c0f503ba6..ef6212374c 100644 --- a/doc/source/deploy/user-guide.rst +++ b/doc/source/deploy/user-guide.rst @@ -1,8 +1,8 @@ .. _user-guide: -======================= +====================== Introduction to Ironic -======================= +====================== Ironic is an OpenStack project which provisions physical hardware as opposed to virtual machines. Ironic provides several reference drivers which leverage @@ -97,47 +97,44 @@ other resource needs to provision a bare metal instance. Key Technologies for Bare Metal Hosting ======================================= -PXE ------ -Preboot Execution Environment (PXE) is part of the Wired for Management (WfM) -specification developed by Intel and Microsoft. The PXE enables system's BIOS -and network interface card (NIC) to bootstrap a computer from the network in -place of a disk. Bootstrapping is the process by which a system loads the OS -into local memory so that it can be executed by the processor. This capability -of allowing a system to boot over a network simplifies server deployment and -server management for administrators. +Preboot Execution Environment (PXE) +----------------------------------- +PXE is part of the Wired for Management (WfM) specification developed by Intel +and Microsoft. The PXE enables system's BIOS and network interface card (NIC) +to bootstrap a computer from the network in place of a disk. Bootstrapping is +the process by which a system loads the OS into local memory so that it can be +executed by the processor. This capability of allowing a system to boot over a +network simplifies server deployment and server management for administrators. -DHCP ------- -Dynamic Host Configuration Protocol (DHCP) is a standardized networking -protocol used on Internet Protocol (IP) networks for dynamically distributing -network configuration parameters, such as IP addresses for interfaces and -services. Using PXE, the BIOS uses DHCP to obtain an IP address for the -network interface and to locate the server that stores the network bootstrap -program (NBP). +Dynamic Host Configuration Protocol (DHCP) +------------------------------------------ +DHCP is a standardized networking protocol used on Internet Protocol (IP) +networks for dynamically distributing network configuration parameters, such +as IP addresses for interfaces and services. Using PXE, the BIOS uses DHCP to +obtain an IP address for the network interface and to locate the server that +stores the network bootstrap program (NBP). -NBP ------- -Network Bootstrap Program (NBP) is equivalent to GRUB (GRand Unified -Bootloader) or LILO (LInux LOader) - loaders which are traditionally used in -local booting. Like the boot program in a hard drive environment, the NBP is -responsible for loading the OS kernel into memory so that the OS can be -bootstrapped over a network. +Network Bootstrap Program (NBP) +------------------------------- +NBP is equivalent to GRUB (GRand Unified Bootloader) or LILO (LInux LOader) - +loaders which are traditionally used in local booting. Like the boot program +in a hard drive environment, the NBP is responsible for loading the OS kernel +into memory so that the OS can be bootstrapped over a network. -TFTP ------- -Trivial File Transfer Protocol (TFTP) is a simple file transfer protocol that -is generally used for automated transfer of configuration or boot files between -machines in a local environment. In a PXE environment, TFTP is used to -download NBP over the network using information from the DHCP server. +Trivial File Transfer Protocol (TFTP) +------------------------------------- +TFTP is a simple file transfer protocol that is generally used for automated +transfer of configuration or boot files between machines in a local +environment. In a PXE environment, TFTP is used to download NBP over the +network using information from the DHCP server. -IPMI ------- -Intelligent Platform Management Interface (IPMI) is a standardized computer -system interface used by system administrators for out-of-band management of -computer systems and monitoring of their operation. It is a method to manage -systems that may be unresponsive or powered off by using only a network -connection to the hardware rather than to an operating system. +Intelligent Platform Management Interface (IPMI) +------------------------------------------------ +IPMI is a standardized computer system interface used by system administrators +for out-of-band management of computer systems and monitoring of their +operation. It is a method to manage systems that may be unresponsive or powered +off by using only a network connection to the hardware rather than to an +operating system. Ironic Deployment Architecture @@ -297,7 +294,7 @@ This process is used with pxe_* family of drivers. (From a `talk`_ and `slides`_) Example 2: PXE Boot and Direct Deploy Process ----------------------------------------------- +--------------------------------------------- This process is used with agent_* family of drivers. diff --git a/doc/source/dev/contributing.rst b/doc/source/dev/contributing.rst index 506560c145..9e1426f5a1 100644 --- a/doc/source/dev/contributing.rst +++ b/doc/source/dev/contributing.rst @@ -33,15 +33,15 @@ authentication. * https://launchpad.net/ironic Related Projects ------------------ +---------------- - * https://launchpad.net/ironic-inspector - * https://launchpad.net/python-ironicclient - * https://launchpad.net/python-ironic-inspector-client - * https://launchpad.net/bifrost +* https://launchpad.net/ironic-inspector +* https://launchpad.net/python-ironicclient +* https://launchpad.net/python-ironic-inspector-client +* https://launchpad.net/bifrost Project Hosting Details -------------------------- +----------------------- Bug tracker http://launchpad.net/ironic diff --git a/doc/source/dev/dev-quickstart.rst b/doc/source/dev/dev-quickstart.rst index 4c902a2e8d..ba653ee626 100644 --- a/doc/source/dev/dev-quickstart.rst +++ b/doc/source/dev/dev-quickstart.rst @@ -618,3 +618,4 @@ commands to build the documentation set:: Now use your browser to open the top-level index.html located at:: ironic/doc/build/html/index.html + diff --git a/doc/source/drivers/ilo.rst b/doc/source/drivers/ilo.rst index 2d9a63a364..18f7f52dc7 100644 --- a/doc/source/drivers/ilo.rst +++ b/doc/source/drivers/ilo.rst @@ -317,7 +317,7 @@ Hardware Inspection Refer to `Hardware Inspection Support`_ for more information. Swiftless deploy for intermediate deploy and boot images -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Refer to `Swiftless deploy for intermediate images`_ for more information. HTTP(S) Based Deploy @@ -1483,3 +1483,4 @@ To create an agent ramdisk with ``Proliant Hardware Manager``, use the ``proliant-tools`` element in DIB:: disk-image-create -o proliant-agent-ramdisk ironic-agent fedora proliant-tools + diff --git a/doc/source/drivers/ipa.rst b/doc/source/drivers/ipa.rst index bebbafba5d..1c54aae1b6 100644 --- a/doc/source/drivers/ipa.rst +++ b/doc/source/drivers/ipa.rst @@ -124,3 +124,4 @@ that you have to update the node's ``driver_info`` field and set the example, the below command sets this configuration in a specific node:: ironic node-update add driver_info/deploy_forces_oob_reboot=True + diff --git a/doc/source/drivers/oneview.rst b/doc/source/drivers/oneview.rst index 710d305348..1760b43dae 100644 --- a/doc/source/drivers/oneview.rst +++ b/doc/source/drivers/oneview.rst @@ -168,7 +168,7 @@ Here is an overview of the deploy process for this driver: 12. Baremetal node is active and ready to be used. Registering a OneView node in Ironic -===================================== +==================================== Nodes configured to use any of the OneView drivers should have the ``driver`` property set to ``iscsi_pxe_oneview`` or ``agent_pxe_oneview``. Considering diff --git a/doc/source/webapi/v1.rst b/doc/source/webapi/v1.rst index c0e2d6ae58..3d2c60d2cf 100644 --- a/doc/source/webapi/v1.rst +++ b/doc/source/webapi/v1.rst @@ -1,6 +1,6 @@ -===================== - RESTful Web API (v1) -===================== +==================== +RESTful Web API (v1) +==================== API Versioning ==============