openstack/cinder
Code Issues Proposed changes
89de47b0d6
cinder/doc
History
tushargite96 89de47b0d6 Configure a storage node in cinder 
The solution is already provided in the
Troubleshoot the Block Storage configuration[1] if
Block Storage service may have issues locating the
persistent tgt include file .

But if we add tgtd configuration in installation steps
as suggested by the warning in the log like we did
in manual installation for openSUSE and
SUSE Linux Enterprise it will be more user friendly
for smooth installation.

[1]: https://docs.openstack.org/cinder/xena/admin/ts-cinder-config.html#id2

Closes-Bug: #1946645
Change-Id: If9b0936d4bd3efbf42a32e256c98816b4fd76c34
2023-03-07 23:05:12 +05:30
..
ext Make docs build parallel 2020-10-22 10:28:01 -05:00
source Configure a storage node in cinder 2023-03-07 23:05:12 +05:30
test docs: Remove unnecessary 'blockstorage-' prefix 2022-02-20 19:06:32 +00:00
.gitignore Make doc/source directory compliant with design in spec 2017-07-19 15:59:02 -05:00
README.rst Update and replace http with https for doc links in Cinder 2017-07-27 09:58:23 +00:00
requirements.txt docs: Add whereto for testing redirect rules 2022-02-20 19:05:46 +00:00

README.rst

Cinder Development Docs

Files under this directory tree are used for generating the documentation for the Cinder source code.

Developer documentation is built to: https://docs.openstack.org/cinder/latest/

Tools

Sphinx

The Python Sphinx package is used to generate the documentation output. Information on Sphinx, including formatting information for RST source files, can be found in the Sphinx online documentation.

Graphviz

Some of the diagrams are generated using the dot language from Graphviz. See the Graphviz documentation for Graphviz and dot language usage information.

Building Documentation

Doc builds are performed using tox with the docs target:

% cd ..
% tox -e docs