openstack/nova
Code Issues Proposed changes
52cc4bfa0a
nova/doc/source/configuration/index.rst
Akihiro Motoki 152d5c359c doc: Improve PDF document structure 
This is a follow-up patch for https://review.opendev.org/676730.

In the TOC of the current PDF file [1], most contents related to
user and admin guides are located under "For Contributors" section.
This is weird. It happens because the latex builder constructs
the document tree based on "toctree" directives even though they
are marked as "hidden".

This commit reorganizes "toctree" per section.
The "toctree" directives must be placed at the end of
individual sections. Otherwise, content of a last section and
content just after "toctree" directive are concatenated
into a same section in the rendered LaTeX document.

This commit also improves the following as well:

* Specify "openany" as "extraclassoptions" to skip blank pages
  along with "oneside" to use same page style for odd and even pages.
* Set "tocdepth" and "secnumdepth" to 3 respectively.
  "tocdepth" controls the depth of TOC and "secnumdepth" controls
  the level of numbered sections in TOC.

Note that this commit does not reorganize file structure under doc/source.
I believe this should be done separately.

[1] https://docs.openstack.org/nova/latest/doc-nova.pdf

Change-Id: Ie9685e6a4798357d4979aa6b4ff8a03663a9c71c
Story: 2006100
Task: 35140
2019-10-08 11:06:00 +01:00

2.4 KiB
Raw Blame History

Configuration Guide

The static configuration for nova lives in two main files: nova.conf and policy.json. These are described below. For a bigger picture view on configuring nova to solve specific problems, refer to the Nova Admin Guide </admin/index>.

Configuration

  • Configuration Guide </admin/configuration/index>: Detailed configuration guides for various parts of your Nova system. Helpful reference for setting up specific hypervisor backends.
  • Config Reference <config>: A complete reference of all configuration options available in the nova.conf file.

html

  • Sample Config File <sample-config>: A sample config file with inline documentation.

config

html

sample-config

Policy

Nova, like most OpenStack projects, uses a policy language to restrict permissions on REST API actions.

  • Policy Reference <policy>: A complete reference of all policy points in nova and what they impact.

html

  • Sample Policy File <sample-policy>: A sample nova policy file with inline documentation.

policy

html

sample-policy