Via If3c74703a684fbd5a815e073cc9da34e9ad672e8 we're adding a new
set of tasks, let's document those.
Change-Id: I9af03c6de241ad7fe706ee12bdd2a6eece9880a6
Depends-On: If3c74703a684fbd5a815e073cc9da34e9ad672e8
The DefaultPasswords interface was removed from tripleo-heat-templates
in Change-Id If83d0f3d72a229d737a45b2fd37507dc11a04649.
Change-Id: I42913c36b634ad1fb1c1b4cc0c798fe98dc430c2
sphinxcontrib-mermaid 0.6.1 causes issue seen in LP bug
1916280. Newer version of sphinxcontrib-mermaid will fix
so let's avoid problem with known issue.
Change-Id: Iad6b3faa1a4428ce9a59efbc879bcf5a0f394cc1
Closes-Bug: #1916280
This updates the current promotion-stages doc and introduces
the concept of component and integration pipelines.
Change-Id: I77d38d0474a5f7c202e9eb61e5d18f8e59bade86
sphinxcontrib-mermaid is including six but isn't requiring it. Let's add
it here for the pdf support to continue to function.
Change-Id: I53cbfe9f3deb4802aa2e608fa9a0bd66391aac68
For the first time, we now have a manual that describes the expectations
of our core reviewers and hopefully will help people to understand how
they can become core at some point.
Note: this was inspired by https://wiki.openstack.org/wiki/Ironic/CoreTeam
Thanks to the Ironic team for writting this.
Change-Id: I05f8eda29d03adac948159418b0763c5f8b5ddec
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.
Disable openstackdocs_auto_version to not auto-version the documents.
Disable openstackdocs_auto_name to use 'project' variable as name.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I6f7b0e00c112f62dd94a907284fcb3698e84479d
The TripleO core list has been broken down
into topic specific lists in some cases.
Ensure we have those groups documented
Change-Id: I6dcfefec9fbb0a1b6824b030242a384b1b9eca47
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Remove obsolete sections from setup.cfg
- Update classifiers
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Remove install_command from tox.ini, the default is fine
- Remove unneeded test-requirements.txt file
- Use basepython=python3 for testenv, remove it elsewhere
Change-Id: I2659000c905b3de2f37bd88ab348d2f45e0968cc
Adds a section into chasing ci promotions doc to explain
how to override the tripleo-ci-testing hash when running
testproject jobs.
Change-Id: If475adc4c2b14d9303e73db58094be16b0c465d0
It adds information about:
* TripleO jobs running against ceph-ansible/podman github
pull requests.
* How to recheck the failed jobs.
* How to file an issue.
* Depends-On usage
* check-rdo vs check-github
https://tree.taiga.io/project/tripleo-ci-board/task/1389
Change-Id: I779b306776d7b629d158368a6182748c7b8c86dc
Signed-off-by: Chandan Kumar (raukadah) <chkumar@redhat.com>
Some docs about the promotion process from the ruck|rover
perspective and note about testproject and periodics
Change-Id: I37fe3146d6d5d33dcfa2a09b3d0620f137c7efd5
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
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
