the type of app.builder.srcdir is now a _StrPath which
breaks the invocation of replace when generating
redirects.
This change just fixes that by wrapping it in str()
Change-Id: Ic8936c2e657a2a0212b1bc96915ba6e2035569b3
This was a great tool but it seems it is no longer maintained, with no
commits since late 2021 [1]. Remove it, capturing static copies of the
SVGs it was generating so we don't lose information. The original
"source" is retained in case we ever want to revive our use of the tool
but that seems unlikely at this point.
[1] https://github.com/blockdiag/blockdiag
Change-Id: Ie3f89730128fdb8beca8bb02312d11516affcbbc
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
This is mostly a brain-dump spec on the topic of compute hosts and
how fragile they are in terms of hostname handling. There has long
been a requirement that computes can NEVER change hostnames, and we
have few tools to even detect the problem before we corrupt the
database if it happens.
Here I have documented some of the things we could do to make that
more robust, should we choose to do so. This is based on a recent
near-catastrophe and thus reflects things that would have avoided
pain in a real scenario.
Per discussion at the PTG, I am adding this as a backlog spec, to be
an overarching guide for multiple smaller specs to provide more
detailed progress towards the goals described here.
Change-Id: I72fa3f605cfcf7c3dd0ff4c791be7df8f19f058b
It seems Sphinx 4.4.0 made the _`[1]` type of references global. These
were document local references in the past. The nova spec repo has
multiple documents reusing such reference labels. So with 4.4.0 the doc
build fails with duplicate reference error.
This patch pins the Sphinx version to unblock the doc build job.
Change-Id: I3bb152d1c823b0e3f8a85f3f3f368a76bdfbe033
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow parallelizing building of documents.
Update Sphinx version as well.
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.
Set openstackdocs_auto_version to not version the documents.
Set openstackdocs_auto_name to use project 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.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I6cfa321e91f8a9fdbb9d6392f9740d41290ed545
Sphinx 2.0.0 dropped Python 2.7 support. This is aligned with
[1] in requirements project.
[1]Change-Id If558f184c959e4b63b56dec3ca1571d1034cfe5c
Change-Id: Ie042cc50d49251be589467e921a03b033845fe7d
Scrubbing the backlog directory.
This spec has been here since 2015.
It is probably related to [1], but I haven't dug into that yet. The
authors of either spec should feel free to modify this commit to
clarify.
[1] https://review.openstack.org/#/c/635408/
Change-Id: I1e5267a828133e9a6579a6790f2996c64a88fc8d
Adds tooling and enhances README documentation around the backlog specs
process.
- To move a spec from the backlog to the current release, we can now use
the ``move-spec`` tox target, e.g.
tox -e move-spec -- [-n] [-v] specs/backlog/approved/great-idea.rst specs/train/approved
- To abandon a backlog spec - i.e. move it from specs/backlog/approved
to the (new) specs/abandoned directory, we can now use the
``abandon-spec`` tox target, e.g.
tox -e abandon-spec -- [-n] [-v] specs/backlog/it-was-a-great-idea.rst
These utilities will move the specified spec into the target directory
and create an appropriate redirect for it.
To make it so, this commit factors out a helper method that a) moves a
spec from one subdirectory to another and b) adds a redirect for it.
This is used by the existing ``move-implemented-specs`` utility as well
as the new ``move-spec`` and ``abandon-spec``.
While I was in here, I spruced up the verbose output (including for
move-implemented-specs) to be a bit more readable.
Change-Id: I322eecbacd5dc52accf6ac69c9fe1116be8c216f
There are multiple steps necessary here:
- Switch to openstackdocstheme which, unlike the EOL'd oslosphinx theme,
supports Sphinx 2.0. This is mostly trivial, though we do need to set
the 'release' and 'version' options to the empty string since specs,
like release notes and API docs, are unversioned.
- Require yasfb 0.8.0, which adds support for Sphinx 2.0
- Remove configuration for configuration for the 'autodoc' extension,
any builder that isn't HTML or LaTeX, or stuff that duplicates
defaults. All of these were noise that was simply confusing matters.
Change-Id: I111f5e2b0314b35bdde3e00f7615a380734bc2aa
This moves the completed Stein specs to the implemented directory and
adds the redirects. This was done using:
$ tox -e move-implemented-specs stein
This also removes the stein-template symlink from the docs.
And renames the handling-down-cell_new.rst spec to handling-down-cell.rst
to match the blueprint.
Change-Id: Id92bec8c5a2436a4053765f735d252c7c165f019
This moves the completed rocky specs to the implemented
directory, adds the redirects and also removes the rocky-template
symlink from the approved directory and docs.
This was done using:
$ tox -e move-implemented-specs -- rocky
Change-Id: I298d6d106f392b662930be97bf88637f1056c0d8
Virt drivers need to be able to change the structure of the provider
trees they expose. When moving existing resources, existing allocations
need to be moved along with the inventories. And this must be done in
such a way as to avoid races where a second entity can create or remove
allocations against the moving inventories.
Change-Id: I1508c8e12c75b24ec9da04468b700b60f055ec24
blueprint: reshape-provider-tree
This moves the completed queens specs to the implemented
directory, adds the redirects and also removes the queens-template
symlink from the approved directory and docs.
This was done using:
$ tox -e move-implemented-specs -- queens
Change-Id: I9e4d9aec4a1ced181ef7850627b9c67de376beae
We don't build anything by HTML output, so most of the commented out
code from the file can be removed.
Change-Id: I41f35bf1ba1e1d11313a382108b17f0bf019008a
For some reason, the gate was failing with the following message:
"WARNING: no "man_pages" config value found; no manual pages will be
written"
I don't know why this has suddenly started happening, but it was
mitigated by 'I97d4ade4'. However, this change didn't fix the root cause
of the issue, which is that 'pbr' defaults to building both html and man
page output and we don't need/want the latter.
Disable the man page builder entirely. This allows us to remove all man
page-related configuration in the process, seeing as it'll never be
used.
Change-Id: I83bb54f413cbad29afb2233043150fb037bca3bd
The deadline for non-priority specs for Ocata has passed. Create the
Pike spec directories, such that folks can re-target their spec now for
review during the Pike cycle.
Change-Id: Ic4c13200b0418668f22ec0e4338b4f09d326abe0
The deadline for non-priority specs for Newton is almost here,
and as always there will be a large number of specs that do
not get approved. Any that remain in the Newton directory will
eventually get force abandoned. Opening up the Ocata directory
allows submitters who wish to re-target their effort to the
subsequent release, to move their spec across to the new
directory straight away enabling ongoing visibility & review.
Change-Id: I732576bb3c0e60ec130cdf73647fbc2f234905f7
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
The glob stanzas seem to not want .rst extension on includes. Drop it,
and the priorities list returns into the main index.
Change-Id: I8e6213425b602d2545cd6dbfc01bde7ea4bafd8c
Make the order of the priorities match the specifications order, where
we have the newest at the top.
Change-Id: I8a7bb38f27450a144d47388a65167ea9fdeda70f
Now we have the name for newton, we should open specs so people can
start targeting changes, either new or deferrals from Mitaka.
Change-Id: I84322ba6315316bf3d4ad3923067c5c8e7a9461e
As discussed at the Liberty mid-cycle, we should open the Mitaka specs so
that people can start targeting changes, either new or deferrals from
Liberty.
Change-Id: I6fe26e5665dcfd4e1a7fc6c0f7b7a9532e825640
Now that we are starting to get backlog specs, make it clear how one can
take it over and implement it.
* Make it clear on the landing page that backlog specs are looking for
owners. Hopefully this will guide developers looking for a spec to
work in to the right place.
* Explain how to take over a backlog spec.
Change-Id: Ia3585c515c115e073c00e3222fc6718da79792b9
* Link to Liberty template
* Add empty backlog/approved directory
* Update backlog index
* Since we cannot have an empty approved directory, link to
backlog-template for now.
Change-Id: I5f91e28f8d5d55397ba7d9f0c9881cce477a4e6b
Make liberty specs index look like the Kilo one, and make sure specs
being proposed to specs/liberty/approved get rendered in the docs job.
Add symbolic link to template in approved and implemented directories so
they aren't counted as empty and the docs build. Fix template to pass
unit tests.
Once a spec is added to approved and implemented respectively the
symbolic links can be removed.
Change-Id: I020a9d32892ef77aa93406a22173c355e106988b
Takashi Natsume