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
I1a546d4b39c507336d3364f9d1c0129c04bec1f6.)
Change-Id: I94ab1898b83fe708703dccc49df83bae3cd12fc6
Version 1 of the Images API was removed in Rocky by Change
Ia086230cc8c92f7b7dfd5b001923110d5bc55d4d. This patch removes
the version 1 "user guide" documentation.
Change-Id: Idc4986671df623f4e5a953c49918be66b973aada
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.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: If08d763c2c0f09faa61c327ab64f1ad7b1549262
Follow up patch to fix the minor comments on base patch [1].
[1] https://review.opendev.org/#/c/717665
Change-Id: I76e0fdb8af559e65dce8a0f813f284d0fce1e772
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
Change-Id: I3287169563c44d05cfab0329af9756f6de4f885c
Moves the appropriate specs from 'approved' to 'implemented' and
sets up the http redirects so that current links to the specs won't
break.
Change-Id: I21834bf265fab97332a17fbca5f3bad89ae1dc0e
Moves the appropriate specs from 'approved' to 'implemented' and
sets up the http redirects so that current links to the specs won't
break.
Change-Id: Ifb819dcc01a643ba39962f47c7165bafa624392e
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.
Change-Id: I6482178dfbd4be00d997b80c068f465875103cff
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
Change-Id: Ice1ab9657e236d969df50016a3b47a893e6aff0c
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.
Change-Id: I48aa6a2f11831ffc544e8b02b0bfdb80aa51d3e2
Move the implemented Queens specs from 'approved' to 'implemented'
and set up redirects so links to 'approved' won't break.
Change-Id: I6f228424d677f1b4c47b6784732c0ab10cd2aa47
One of the changes in https://review.openstack.org/#/c/523233/ was
commented out by mistake. This patch corrects that.
Closes-bug: #1735935
Change-Id: I30bb1403ad4300909ef314f3b9402fc360c30ec6
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.
Change-Id: I8aac14f306f35d14ca06ca742f556ef8afb866fe
Set up whereto so that any redirect rules added to the .htaccess file
can be tested.
Change-Id: I2238a2163c26b7df9c6a3dfaf0f8701631ff2cc5
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
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
Change-Id: I4da477fd39685a22fb4ef9d702af9b9a79bda0c2
Adds the Queens priorities list. Also moves the old priority lists
to their own archive page in order to de-clutter the specs landing
page.
Change-Id: I4b54f689575f3420ccc78670d71b26a8fe25f9f3
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
prominent.
Change-Id: I85b096fc0c99a70e3ad0d7f8727b7d5ab679c95b
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.
Change-Id: I98ffb4f1084e8f1dc953d81b3959bfe704b52fab
Closes-Bug:#1693670
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.
Change-Id: I074fc782eca1c3e3c9a1c504501973300741b110
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
63e6dbb1eb006758fbcf7cae83e1d2eacf46b4ab.
Change-Id: I62315efc12ee05aea5f55d020006cbb2ad279876
Partial-bug: #1618495
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 <nik.komawar@gmail.com>
Co-Authored-By: Brian Rosmaita <brian.rosmaita@rackspace.com>
Change-Id: I16d1dd18c3efceb2245239f9c95483e717c70c4d
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.
Change-Id: I761503490899c47f875e4ca07c4e941eb53390b8
Closes-Bug: #1529836
Instead of splitting specs per cycle, let the index point to the cycle
index and use 2 sections: one for Glance and another for glanceclient.
Change-Id: I7959a2128b9e3b3cd92e03b125052db85c97a9cf
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.
Change-Id: I312d0dcd815da10f083f2fb2a673f7c192c231f4
Now that the name of the new milestone has been decided, it is time to create
a folder to house specs for it.
Change-Id: Ic13e5f89f600d3d48f4f8c16576d4a5722e1110a
Add blueprint for using a keystoneclient session object within
glanceclient.
Implements: bp session-objects
Change-Id: I4f23b36b4b68f3b9971042c96d7f5f5ab47e500f
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.
Change-Id: I7b6fbb1ee4a9a2e04395a7aa942d9ebdb011cc85
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.
Change-Id: I28c02aff7a8d34ae6c5749c3cd8214a90ba593f3
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
warnings.
Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
YuehuiLei