f313d7a87f
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 job. The list of changes: - copy the docs testenvs' dependencies from Ib3bb34191582f581c28f2f8a0281cf3ae44003e8 - 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: https://governance.openstack.org/tc/goals/train/pdf-doc-generation.html https://etherpad.openstack.org/p/train-pdf-support-goal https://etherpad.openstack.org/p/pdf-goal-train-common-problems 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] Change-Id: Ib3bb34191582f581c28f2f8a0281cf3ae44003e8 Signed-off-by: Bogdan Dobrelya <bdobreli@redhat.com>
148 lines
3.3 KiB
ReStructuredText
148 lines
3.3 KiB
ReStructuredText
Welcome to |project| documentation
|
|
====================================
|
|
|
|
TripleO is a project aimed at installing, upgrading and operating OpenStack
|
|
clouds using OpenStack's own cloud facilities as the foundation - building on
|
|
Nova, Ironic, Neutron and Heat to automate cloud management at datacenter
|
|
scale
|
|
|
|
Contributor Guide
|
|
-----------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
:includehidden:
|
|
|
|
contributor/index
|
|
developer/index
|
|
|
|
|project| Architecture
|
|
----------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
:includehidden:
|
|
|
|
install/introduction/architecture.rst
|
|
|
|
|project| Components
|
|
----------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:includehidden:
|
|
|
|
install/introduction/components.rst
|
|
|
|
Tripleo CI Guide
|
|
----------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
:includehidden:
|
|
|
|
ci/index
|
|
|
|
Install Guide
|
|
-------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
:includehidden:
|
|
|
|
install/index
|
|
|
|
Upgrades/Updates/FFWD-Upgrade
|
|
-----------------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
:includehidden:
|
|
|
|
upgrade/index
|
|
|
|
Documentation Conventions
|
|
=========================
|
|
|
|
Some steps in the following instructions only apply to certain environments,
|
|
such as deployments to real baremetal and deployments using Red Hat Enterprise
|
|
Linux (RHEL). These steps are marked as follows:
|
|
|
|
.. admonition:: RHEL
|
|
:class: rhel
|
|
|
|
Step that should only be run when using RHEL
|
|
|
|
.. admonition:: RHEL Portal Registration
|
|
:class: portal
|
|
|
|
Step that should only be run when using RHEL Portal Registration
|
|
|
|
.. admonition:: RHEL Satellite Registration
|
|
:class: satellite
|
|
|
|
Step that should only be run when using RHEL Satellite Registration
|
|
|
|
.. admonition:: CentOS
|
|
:class: centos
|
|
|
|
Step that should only be run when using CentOS
|
|
|
|
.. admonition:: Baremetal
|
|
:class: baremetal
|
|
|
|
Step that should only be run when deploying to baremetal
|
|
|
|
.. admonition:: Virtual
|
|
:class: virtual
|
|
|
|
Step that should only be run when deploying to virtual machines
|
|
|
|
.. admonition:: Ceph
|
|
:class: ceph
|
|
|
|
Step that should only be run when deploying Ceph for use by the Overcloud
|
|
|
|
.. admonition:: Stable Branch
|
|
:class: stable
|
|
|
|
Step that should only be run when choosing to use components from their
|
|
stable branches rather than using packages/source based on current master.
|
|
|
|
.. admonition:: |oldest_version_name|
|
|
:class: |oldest_version_name_lower|
|
|
|
|
Step that should only be run when installing from the |oldest_version_name|
|
|
stable branch.
|
|
|
|
.. admonition:: |before_oldest_version_name|
|
|
|
|
Step that should only be run when installing from the
|
|
|before_oldest_version_name| stable branch.
|
|
|
|
.. admonition:: |before_latest_version_name|
|
|
:class: |before_latest_version_name_lower|
|
|
|
|
Step that should only be run when installing from the
|
|
|before_latest_version_name| stable branch.
|
|
|
|
.. admonition:: |latest_version_name|
|
|
:class: |latest_version_name_lower|
|
|
|
|
Step that should only be run when installing from the |latest_version_name|
|
|
stable branch.
|
|
|
|
.. admonition:: Validations
|
|
:class: validations
|
|
|
|
Steps that will run the pre and post-deployment validations
|
|
|
|
.. admonition:: Optional Feature
|
|
:class: optional
|
|
|
|
Step that is optional. A deployment can be done without these steps, but they
|
|
may provide useful additional functionality.
|
|
|
|
Any such steps should *not* be run if the target environment does not match
|
|
the section marking.
|