The is one of community goals that each project could produce a
single PDF file. The pdf should be in the output of openstack-tox-docs
The list of changes:
- copy the docs testenvs' dependencies from
- do not place unrelated to the docs testenvs entries for the
test-requieremets.txt, add missing flake8
- add the missing sphinxcontrib-mermaid docs requirements
- render mermaid diagrams only for html builds, for PDF use a hand-made
quick and dirty approximation instead (if used for PDF builds, it
fails on the py3 deprecated warn() methos)
- add the project architecture and components into the main ToC, omit
rendering additional contents pages for PDF builds
- add a new pdf-docs environment to enable PDF build,
- sphinxcontrib-svg2pdfconverter is used to handle SVG properly,
- Add requirements for sphinx and poke it for openstackdocstheme,
- disable usage of xindy for tex,
- do not generate empty pages,
More about the goal:
TeX and few more packages may be needed to build PDF locally
(listed for bindep):
inkscape [doc platform:dpkg]
fonts-liberation [doc platform:dpkg]
texlive-latex-base [doc platform:dpkg]
texlive-latex-extra [doc platform:dpkg]
texlive-xetex [doc platform:dpkg]
texlive-fonts-recommended [doc platform:dpkg]
xindy [doc platform:dpkg]
latexmk [doc platform:dpkg]
texlive [doc platform:rpm]
texlive-fncychap [doc platform:rpm]
texlive-titlesec [doc platform:rpm]
texlive-tabulary [doc platform:rpm]
texlive-framed [doc platform:rpm]
texlive-wrapfig [doc platform:rpm]
texlive-upquote [doc platform:rpm]
texlive-capt-of [doc platform:rpm]
texlive-needspace [doc platform:rpm]
texlive-polyglossia [doc platform:rpm]
latexmk [doc platform:rpm]
python3-sphinxcontrib-svg2pdfconverter-common [doc platform:rpm]
librsvg2-tools [doc platform:rpm]
librsvg2-bin [doc platform:dpkg]
Signed-off-by: Bogdan Dobrelya <email@example.com>
The deployment guide is currently pointed at triplo-docs but it has been
requested that we actually publish a deployment guide. This change
extracts many of the installation doc pages and moves them into the
deploy-guide source tree. Once the deploy-guide is published, we will
follow up to reference the deployment guide from tripleo-docs.
Changed a repositories document from txt to rst to properly render the rst
syntax within, and updated all references to that document. Also updated the
installation document to properly process the auto configured numbering.
With the latest ceph-base change we now have the ability to
override the variables in multiple sections of ceph.conf other
This change improves the existing example of CephConfigOverrides
definition with an additional parameter in the [osd] section.
* Remove section on tripleo-incubator, this repo is retired.
* Replace docs.openstack.org/developer/X with current link
docs.openstack.org/X, use https where missing.
As the all_nodes.json data is now rendered by Ansible, we need to use
the data from the config-download directory instead of using the Heat
Midonet plugin isn't maintained nor supported anymore in TripleO; we
shouldn't document how to deploy the old templates, we don't even know
if they work.
We've changed some of the naming in the Train cycle and need to update
the docs to reflect the current state. Additionally adding notes about
the previous naming conventions.
Example from Ibe2e2302b47efea1c747c0166d552fab4feb31c8
was missing ANSIBLE_PRIVATE_KEY_FILE which will likely
also be needed with CephAnsibleEnvironmentVariables.
The backup and restore doc is getting bigger, now its moved to its own section
also we add support for ReaR.
Co-Authored-By: Juan Badia Payno <firstname.lastname@example.org>
We haven't updated the stable versions for building images in some time.
Additionally since we have had several ceph version upgrades along the
way, let's just use a wild card in the documentation.
Add admonition about how tag_from_label mechanism
works for external projects and clarify that it
doesn't work as expected for ceph containers, so
in this case the ceph_tag defined in the container
image_prepare yaml file will be used.
Now we have CLI support for running the validations.
This submissions improves the current documentation
available and move the current validations docs to
its own section.
This patch updates tripleo docs with podman command equivalents
replacing the old docker ones.
All replaced commands have been tested on a CentOS 7 standalone
environment and are proven to work.