The current paths need '/openstack/glance-specs' prepended to them.
(This was verified by fungi manually editing the deployed .htaccess
file on the specs website, and also by cinder change
Version 1 of the Images API was removed in Rocky by Change
Ia086230cc8c92f7b7dfd5b001923110d5bc55d4d. This patch removes
the version 1 "user guide" documentation.
Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
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.
Make a few cleanups:
- Remove obsolete sections from setup.cfg
- Switch to using sphinx-build
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Remove install_command from tox.ini, the default is fine
The owner_is_tenant option was deprecated in R-1.
The pending-delete revert was merged for R-2.
This patch moves the specs to 'implemented' and sets up redirects
from 'approved' so links won't be broken.
Lite-spec for a dry-run option for db upgrades in glance-manage.
This spec is moved from /specs/untargeted/glance/lite-spec-db-sync-check.rst
to /specs/queens/implemented/glance/lite-spec-db-sync-check.rst because it was
implemented by change I1e0b02d615690f65a17b4ccfe4e4a72cc9e15ada
Update queens specs from 'approved' to 'implemented' or to
rocky/approved or to untargeted, define the redirects, and
make appropriate changes on the supporting pages.
Update the specs repo to indicate the Q-1 implementations.
This includes moving the spec, adding a redirect so the old
URL doesn't break, and adding a 'whereto' test.
Maintenance on oslosphinx ended with the Pike release. This
patch includes the following changes:
* switch to openstackdocstheme
* set context options for openstackdocstheme
- glance-specs doesn't have its own bug tracker, so config
to create bugs in the glance bug tracker with tag 'glance-specs'
* update requirements file
* update setup.cfg to use warning-is-error
* update four specs whose warnings were previously ignored
* add an '_extra' directory with stub .htaccess file
* configure docs build to include '_extra'
* update build command in tox.ini
Glance is now in a specs proposal freeze for Queens, so new specs
must be proposed for Rocky. This patch sets up the directories
and introduces a new spec-lite template to replace the old strategy
of having a single file containing all lite specs. It also reorganizes
the index page slightly to make the current cycle's specs more
Fix the Sphinx html_last_updated_fmt for Python3.
The html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
This commit adds an 'untargeted' directory to hold orphaned specs
that were approved but aren't being worked on. A new index.rst is
added explaining the idea, and adjustments are made to other
appropriate index pages. Additionally, one glanceclient spec from
liberty was stuck in a non-release-name directory; it was moved to
the liberty directory, which in turn was slightly reorganized to
accommodate both glance and glanceclient specs.
This patch updates the "narrative" Images v1 API docs for the
Newton release by adding a deprecation note to each page. That
way the note will be seen even if someone uses a direct link to
one of the pages.
The Images v1 API was deprecated with commit
Some of the Newton specs did not get enough attention from cores
during the cycle. Let's start the Ocata folder for starting planning on
the specs for next cycle.
This needs to be started/merged in Newton for people to start planning
on writing specs and then help the glance team and community
determine/plan work for Ocata.
Co-Authored-By: Nikhil Komawar <firstname.lastname@example.org>
Co-Authored-By: Brian Rosmaita <email@example.com>
For this cycle, I believe we should be more strict on what is/isn't a
priority. Considering the latest feedback from the community and our
current team, we ought to be very careful.
This list does not exclude other works. It just clarifies what
the teams priorities are and where most of the time should probably go.
Also, this list does not define features and it doesn't replace specs.
Specs *must* be written and they'll be referenced in this list.
Goal is to maintain API specs in the specs repo for each project
and to eliminate the image-api repo.
Splits up original v2 API document into multiple files.
We don't want the templates to show up in the RSS feed, so exclude them
from being converted to HTML and listed in the toctree.
Remove the now unused index.rst.
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)
This also removes the requirement for internet access during docs build.
This can cause docs jobs to fail if the project errors out on