Update contributor docs to reflect the discussion of oslo library
usage at the 10 January 2019 Glance weekly meeting.
Change-Id: Ibb75ce0cbc2b906838a5149dc75bfb27383178a7
openstack-dev was decomissioned this night in https://review.openstack.org/621258
Update openstack-dev to openstack-discuss
Change-Id: I6b5a3489c3e09bc1413dbac174310339151df05b
Moves the Release Notes section to its own page to give it a higher
level heading to make it easier to find. Also updates info about
the Glance team's policy about the "prelude" section.
Change-Id: I31351068124e0981519ccc2e33a7bdc16f8197fd
At the weekly Glance meeting on 2018-05-17 it was agreed that the
Release CPL will monitor the periodic "tips" test jobs and report
on their status at the weekly meeting. This patch updates the
appropriate section of the Glance Contributor's Guide.
Change-Id: Ieeab3e3a42b8197f8b0544e97748ffdb8f620f13
Curly quotes(Chinese punctuation) usually input from Chinese input method.
When read from english context, it makes some confusion.
Change-Id: I9b8830179fb98f3a6bef479bbaa12df70311269a
Currently https://docs.openstack.org/glance/latest/ is a long
unorganized list of documentation links. This patch revises that
page and the 'Glance Contribution Guidelines' page to make it
easier to locate content. Also updates the main heading on other
index pages.
Change-Id: Ieea44dd05f8d164ed4c27f1205fb29b6e66d9660
- mark zero-downtime-db-upgrade as EXPERIMENTAL for queens
- clarify the relation between the E-M-C strategy and
zero-downtime db upgrades
- add note that for MySQL, using the glance-manage expand or
glance-manage contract command requires that the glance
is granted SUPER privileges
- add note to contributor docs about checking the trigger
flag in expand and contract scripts
Co-authored-by: Abhishek Kekane <akekane@redhat.com>
Co-authored-by: Brian Rosmaita <rosmaita.fossdev@gmail.com>
Change-Id: I5af4a1428b89ecb05a1be9c420c5f0afc05b9a95
Closes-Bug: #1750555
This patch adds a doc8 check of .rst files to the current pep8 check.
It includes fixes to the .rst files that didn't pass the check.
Co-authored-By: Hoang Trung Hieu <hieuht@vn.fujitsu.com>
Change-Id: I5a9299200202576d97760ebf07bceb930888f2d7
Add a description of the new URL format for project documentation.
We've been getting a bunch of patches to modify URLs and it's hard
to know which ones are the canonical format since there are redirects
so that both the old and new URLs currently work.
Change-Id: I84136af8315f3421f7d7825fdb7d096f019a6e08
In Queens, we've begun putting lite specs into their own
individual files instead of all combined into a single file.
This patch changes the contributor docs to reflect this.
Depends-on: I85b096fc0c99a70e3ad0d7f8727b7d5ab679c95b
Change-Id: I94bc4cb3d73d22b06aa923dd29c64208da6a3477
Use autodoc_index_modules instead of autodoc_tree_index_modules so only
one copy of the API docs are generated.
Exclude the tests subpackage because it's not part of the Glance Python
API.
Exclude the glance.db.sqlalchemy subpackage to avoid issues caused when
parts of it cannot be imported during the doc build because they rely on
alembic setting up values that are not configured for a simple import.
Change-Id: I127b812bc879fc39533b39df1785d93835142430
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This change moves existing files, updates a few of the cross-references
and paths, and fixes some formatting. It is not meant to be the final
word on how the main page looks or how the other files are organized,
but it gets everything roughly into shape. If the glance team wants to
make changes, please do those as follow-up patches
This change depends on the spec and on a feature of pbr that allows us
to move where the auto-generated class reference documentation ends up
in the tree.
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Depends-On: I2bd5652bb59cbd9c939931ba2e7db1b37d2b30bb
Change-Id: I9dde267793a5913acb5b1ec028cfb66bc5189783
Signed-off-by: Doug Hellmann <doug@doughellmann.com>