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>
Adds some basic documentation on how to use NovaEnableRbdBackend as a
per-role param.
Depends-On: I9f40a2a3561fcb1d1fec9d9c3c1f9cabaf02650c
Change-Id: I65ae4ea69b4be3159f28d8bda45f4217dc0b3582
Implements: blueprint nova-backend-per-role
This change improves the ceph dashboard section
including the steps needed to deploy the overcloud
adding a ceph dashboard composable network.
Change-Id: I08bd07cf797c68d6042999bc7f31f01ad352c4bb
This change adds the ceph dashboard deployment
section that describes how to trigger the
ceph ansible related playbooks via TripleO.
Change-Id: Ib56d76aa048188a58a5193f871ed9051f0581cd3
Since we moved the installation items to the deploy-guide, we need to
make sure we properly reference the new locations.
Change-Id: Ic481bf333b868d32638e5970b18c367f9d23d45c
In train we'll add a new tripleoclient command to help with
export stack data which is required for the cell stack input.
Also this change adds a basic and an advanced cell deployment
architecture. Due to release specific features the doc is split
into in different parts (stein,train and cell management)
Depends-On: https://review.opendev.org/672070
Change-Id: Ia14e01f7f8deb55a6ac4f1b30a84352822143c27
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
We add tempest_private_net_provider_type as a featureset_override
in depends-on for scenario7 (ovs) standalone. This adds it to the doc
and updates the outdated link to the allowed overrides.
Depends-On: https://review.opendev.org/674228
Change-Id: I0a80c76bffafa4596888c86753915dd99f538a80
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
We don't use python build_sphinx anymore, replace with sphinx-build
according to PTI. Remove related configuration from setup.cfg.
This repo builds only docs, so no need for a separate
doc/requirements.txt file, remove its usage.
Cleanup requirements files, we need only requirements for building docs.
Update conf.py for newer openstackdocstheme.
Change-Id: I3f37375b77aaf2f652a69d396a2bc22fb7a7ee40
* 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
The tripleo-ci squad grafana instance was just moved to a new host
and we need to update the url http://cockpit-ci.tripleo.org/
Change-Id: I465949fb71ca3963942da042f0ec6d2d4341061c
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
This patch adds some important export of ANSIBLE_* variables as the
validations playbooks are in their own playbooks directory and are not at
the same level as the libraries, plugins, roles ans so on.
Change-Id: I9f3e8344bc9dd69139e7fdef0cd1e88144fcd477
Signed-off-by: Gael Chamoulaud <gchamoul@redhat.com>
This patch adds documentation for the new TripleO Validations CLI
features:
When listing validations:
* '--extra-vars', which allows us to pass extra vars as a Dictionary
* '--extra-vars-file', which allows to pass a json or a yaml file
instead of a Dictionary
When running validations:
* '--parameters', which allow us to get only a list of the available
Ansible variables for the validations
* '--create-vars_file', which allows us to create a valid json or yaml
file containing the available variables.
Change-Id: Ifa6786de133da5129b610b8e17fba773df517214
Signed-off-by: Gael Chamoulaud <gchamoul@redhat.com>
Third paragraph has a typographical error - Fuirthermore should be Furthermore.
Change-Id: I984fa050cb559aec8b0d9945a7529bbdcb0d6fd6
Closes-Bug: #1835267
The validations can be performed either by calling Mistral or by
calling ansible-playbook, which is the default now.
Depends-On: I8c833819c88f1822bf605df0c997ab5d651e7620
Change-Id: I19b2c99aaaf99e2d712aa7360656582b8a997a54
Signed-off-by: Gael Chamoulaud <gchamoul@redhat.com>
