Also will have the side effect of publishing the deploy-guide
once this merges on 2023.2 branch which did not happen
automatically.
Change-Id: I7e7929ec1d31bdb650b41bd4f235affce8f36fed
Despite Yoga is an unofficial SLURP release, we're preparing all tooling
and test upgrades from Y to 2023.1. With that we're mentioning
in docs, that upgrade from Y is possible. We also update release names
that are used in docs.
Change-Id: I41eb336016920624bbf0fa7641301c64cce1070a
We also don't use u-c for placement client because of the
regression that breaks utility install and hasn't been tagged
yet.
Change-Id: Ifa659c2dfc76003e2f64cabd307ce17bbfb262a8
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_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: Ia39d9da11dacaff56c97367a30c0ace7385c7128
New version of openstackdocstheme (Victoria+) respects pygments_style.
Since this repo is using now Victoria (master) requirements but has
not branched for Ussuri yet, it uses the new version.
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.
Change-Id: I97eed9ddd952b002830cae20136d6700c46901f9
The repo is Python 3 now, so update hacking to version 3.0 which
supports Python 3.
Fix problems found.
Depends-On: https://review.opendev.org/722854
Change-Id: I190f32b2eea20024c71fc74bac7f5d011768473c
Once role is checked out to the branch, pbr increments latest version
which results in not existing tag in the docs.
So we change the way of getting latest tag of the branch to
`git describe`
Change-Id: I6abb27b23290d04d639696b5821932db7da58546
Replace moved networking-guide with current location.
Replace non-existing anchor in https://galeracluster.com with page link.
Replace some more moved pages with new location.
Fix many places to use https instead of http.
Use internal RST link that can be verified instead of external one
for /user/security/index.html.
Checked with:
sphinx-build -a -E -W -d doc/build/doctrees -b linkcheck doc/source doc/build/html
Change-Id: I0368e509ba6702e0da1a9c96f7cee76a6d35b3e0
sphinxmark is currently broken due to Sphinx 2.0.0 release, this
patch drops all of the code which uses it for now until we land
an upstream fix that unbreaks us.
Change-Id: Iba0bc579b6a82046ca0a0d7177d2ba9fd95ac3a4
The deployment host documentation gets out of date really quickly.
This patch makes it self maintaining. Note that due to the fact
that RDO/SUSE do not implement their repositories for a new
release until much, much later in the cycle, we use the previous
release repo for master. This will self-update during our RC
when the stable branch is cut.
Some formatting adjustments have made to prevent the interpretation
of URL's as links by sphinx and to remove the use of multi-line shell
commands.
Closes-Bug: #1759721
Change-Id: Id28540d335390a52e0eb65a734a1d594235265d6
We don't need that many variables for the deployment guide, there
is barely any substitutions done. Simplify the documentation to
a bare minimum.
On top of this, we adapt for the latest openstackdocstheme.
Change-Id: I3502b6a943bacc6dac1b757961348eb04771750d
Move the playbooks/inventory folder, group_vars, and host_vars to
inventory/ in the root of the OpenStack-Ansible repo. This helps better
organize the repo structure since playbooks/ will now only contain
playbooks, shared task files, and included repo package var files.
group_vars and host_vars are moved alongside the inventory since that's
the default place that Ansible expects those folders and to help better
prepare for Ansible 2.4 where multiple inventories can be loaded,
automatically including relative group and host var files.
Effected docs, scripts, and variables have been updated with the new
paths.
Change-Id: If50e2412c3fd6575d7041deb8ecc9480b04184cc
Since zuulv3 changes, we should publish master branch
on latest instead of draft.
Depends-On: Ib718d4674768380decefc93f6189527b6cf1ed1b
Change-Id: Ie3c12c9b880f1d564a9f367b9a30287695d41198
In order to ensure that the deploy guide and
other doc references point to the right places
we update the URL's accordingly.
Change-Id: I8360c47d108ac673ed744c659ba9d34a3ef4c33e
Closes-Bug: #1711108
In the upgrade tooling and the docs references we use
the series name in a few places. This updates them all
for development in the Queens cycle.
In the docs there are many references to Ocata manuals
which are left alone as the upstream Pike docs have not
been published yet.
Change-Id: Ice2169bd40f5712dd9ec9a9eb946fe0244f32294
Create a new external link alias for role docs to simplify adding links
for them within the deploy guide and to automatically include the
correct branch name within those links.
Closes-Bug: 1620233
Change-Id: I02a474fabe5c1a7499e828c4661cf6b232886409
Since the deploy guide moved to a separate directory structure, relative
links throughout the docs have been pointing to nothing. This change
applies some logic to figure out the correct format for URLs based on
the current branch and the deploy guide/dev docs conventions.
The actual link generation is done via the sphinx.ext.extlinks
extension, which allows for defining custom link generation roles. This
achieves the desired behavior in terms of dynamic link construction, but
does alter the standard linking conventions.
Another side effect is that docs generate this way will always point
to the live URLs, not to HTML generated for a gate job. It may be
worthwhile using relative links within the deploy guide/developer docs
and only using these automatic external ones for cross-references.
Usage for dev docs looks like this:
:dev_docs:`Link title text <last-part-of-url.html>`
And for the deploy guide:
:deploy_guide:`Link title text <last-part-of-url.html>`
Some examples inline have been provided, to demonstrate how these fit in
different contexts.
Some small code style fixes are also included.
Change-Id: I4d065f1f2d7c1372f3f829ab9e5297d5028f2ee6
Also removes old install guide in favor of the commited deploy guide
TODO: Link for the deploy guide to be commited
Change-Id: I72c1d344a4cc8df4d92ff296200704639771eb88
Jonathan Rosser