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.htmlhttps://etherpad.openstack.org/p/train-pdf-support-goalhttps://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>
Since we moved the installation items to the deploy-guide, we need to
make sure we properly reference the new locations.
Change-Id: Ic481bf333b868d32638e5970b18c367f9d23d45c
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.
Change-Id: I0ebd26f014180a92c6cf4ab0929d99b2d860796f
Tripleo-ui has been removed as of Train. But we should keep the docs
around a bit longer as we don't branch tripleo-docs.
Change-Id: Iaaa3f6ece433401d696fe7f5d29d916c5c3d0c26
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.
Change-Id: I7fad6e5f89023575c86fef70f2ee17c1543c546d
Closes-Bug: 1827829
With the latest ceph-base change we now have the ability to
override the variables in multiple sections of ceph.conf other
than global.
This change improves the existing example of CephConfigOverrides
definition with an additional parameter in the [osd] section.
Depends-On: https://review.opendev.org/#/c/658161
Change-Id: I9d5cf96622b895cd0dad83b6fd3e41ed7204d50e
* 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.
Change-Id: I18ff11126a3608a736cbee08c746d91906477c31
There is a typographical errors in baremetal_overcloud.rst. Correcting
spelling from acheive to achieve.
Change-Id: If42152e768b590f14716e38f65d8f9ce2a94c46f
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
stack output.
Change-Id: I4f742ed182c9377ae66998934c145ead9295a724
Depends-On: Ib3838d404b45ae6684ef7e0aa211cb8015271866
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.
Change-Id: I826e7e9adc13a25853dd6b01a972949f5c150696
Third paragraph has a typographical error - Fuirthermore should be Furthermore.
Change-Id: I984fa050cb559aec8b0d9945a7529bbdcb0d6fd6
Closes-Bug: #1835267
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.
Change-Id: Ica16b31f332f6b8559a14617126037407f4e8165
Example from Ibe2e2302b47efea1c747c0166d552fab4feb31c8
was missing ANSIBLE_PRIVATE_KEY_FILE which will likely
also be needed with CephAnsibleEnvironmentVariables.
Change-Id: I08ba71dbc437102b4d53d65a7c357cfc026ffe33
Show how to pass CephAnsibleEnvironmentVariables when
running config-download manually to configure Ceph.
Change-Id: Ibe2e2302b47efea1c747c0166d552fab4feb31c8
The backup and restore doc is getting bigger, now its moved to its own section
also we add support for ReaR.
Change-Id: I82d77aa08cd8e3ac09fe55ce67af6da01b577eaf
Co-Authored-By: Juan Badia Payno <jbadiapa@redhat.com>
- Update the container image prepare document for dev mode install:
https://github.com/openstack/ansible-role-tripleo-modify-image#dev-install
- Update standalone manual to refer to the container image prepare page
for special needs during a standalone deployment.
Change-Id: I666dc2b00ebbe56d957526a2a0b1966ddfcdfcf7
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.
Change-Id: I4b0f167f5cf9ee3b964ef809c435dc7403d260c7
Closes-Bug: #1819554
Adds docs and start of an example for multiple stack support with DCN.
Change-Id: I0dea73faf18bf1a350e173a7ae9f1fe49844ae13
Depends-On: I8a8825ecff9fc99b5de7390075470356397d85a2
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.
Change-Id: Ide6f67a4643e9a7943a1271403def7de6721b890
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.
Change-Id: Ia36b0d557e2a362294e7ab9e7781ea3a09cb0450
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.
Change-Id: Ic138604184c31b6afa8731770dbcf173e0352cef
Bogdan Dobrelya