Commit Graph

5 Commits

Author SHA1 Message Date
Luong Anh Tuan 5d2c8fa9e1 Fix the format file name
The file name should be marked follow [1]
as consistent with their semantic meaning.

[1] https://docs.openstack.org/doc-contrib-guide/rst-conv/inline-markups.html#file-name-and-path

Change-Id: Ic18d0563412650d3b42c2ed5c07e69f309877cb9
2017-11-27 11:43:41 +07:00
Stephen Finucane 2dedda8b6b doc: Add configuration index page
Change-Id: Ic318e04be73639de7d26e53e1f0b152d9803fd2f
2017-09-06 14:40:17 +01:00
Stephen Finucane b03e815134 doc: Start using oslo_policy.sphinxext
Providing a sample policy file is all well and good, but it's not
exactly designed for readability on the web. Make use of the 'sphinxext'
module built into oslo.policy to do this.

Change-Id: I6cceeca7edcacb762daa1f22f2138e2d2334b3a2
2017-08-03 16:06:14 -04:00
Stephen Finucane 83a9c2ac33 doc: Start using oslo_config.sphinxext
Providing a sample configuration file is all well and good, but it's not
exactly designed for readability on the web. Make use of the 'sphinxext'
module built into oslo.config to do this.

Change-Id: I75e8f0adae7cfaaa6020870cdb20dc2144fc70eb
2017-08-03 16:06:14 -04:00
Stephen Finucane 18be5324d6 doc: Populate the 'configuration' section
Per the spec [1]:

  configuration/ – automatically generated configuration reference
  information based on oslo.config’s sphinx integration (or manually
  written for projects not using oslo.config). Step-by-step guides for
  doing things like enabling cells or configuring a specific driver
  should be placed in the admin/ section.

Only the 'sample_policy' and 'sample_config' files fit into this
category at present. We may wish to add files that use the oslo.config
and oslo.policy Sphinx integrations, but that can come later.

[1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration

Change-Id: I587551ada1932876bca51a362f8dfeef6f7dd70b
2017-07-18 15:41:19 +01:00