We have many microversions but we but we haven't kept the samples, docs,
and tests up to date with them.
Of the many microversions this patch will focus on the ones that have
updated the fields returned for volumes updating the docs, adding the
appropriate json samples, updating the tests, and updating the
contributor docs to highlight the need to keep these up to date.
Some convenience methods have been added to facilitate the testing:
- use_versions: class decorator that allows us to run the same tests
with different microversions, each using their respective json and
templates.
- override_mv: method decorator to change the microversion in a single
test.
- common_api_sample: context manager to use the base sample instead of a
microversion specific one.
Change-Id: Ide303685a4cd1477c319b36e67a3b05c8d129126
Our cgit instance will be going away and opendev.org is the new
preferred URL for browsing our git repos. Redirects will exist for the
foreseeable future, but it's more efficient to just go directly to the
new locations.
Change-Id: I4b7150e5116147c9be05fd9d698e7f3c747513a8
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
It is been agreed upon that if a new feature is proposed
sharing similarities (in terms of intention and code)
with a previously merged feature then both the features
can be clubbed together within the same (previous feature)
microversion given that the previously merged feature isn't
released.
Change-Id: I80216f9c2645ece1ea4c57550936a247440a5a82
This cleans up the cases where we had D001 violations so we can stop
skipping that check in doc8 runs.
Change-Id: Ie52f6ecac1a645fcbcc643b9ca63e033b622d830
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
The REST API Version History was being listed in the top level
TOC for the contributor guide, causing each microversion to show
up as a separate item in the table of contents. This looks a odd
and causes a lot of scrolling to get to some of the contributor
information.
This moves the version history under the API Microversions
section so all microversion information is within on section of
the guide.
Change-Id: I74232b52088a395b618e07902427889200c2fdae
We very often end up with merge conflicts for any patches that increment
microversions due to conflicting numbers. We can't really solve that,
but we can avoid the need to update version numbers throughout the code
by defining a constant value in one place and using that variable instead.
Change-Id: Ib3a80fee6caaabb49af097aa197f550c65d94985
The following spec defines what each project's doc/source
directory is supposed to look like:
https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
I had not yet moved existing content to follow this design.
This patch does that, moving the devref to the
'contributor' directory. It also moves the CLI
related documentation into the 'cli' directory. I have
updated the autodoc generation to now create the api
documentation in 'doc/source/contributor/api'.
This patch also creates a template for future documentation
contribution. I have created all of the directories
recommended by the spec and have included documentation
as to what should go in each directory.
The index file is updated to point at the new locations for
existing content.
'doc/.gitignore' is updated so that it won't complain about the
automatically generated 'doc/contributor/api' directory.
Change-Id: I55c50fa0b7c1d06c91e40dbcfd11b1c8e8378aa6
Gorka Eguileor