17 Commits

Author SHA1 Message Date
Brian Rosmaita
cf2b3f25aa Update "Disallowed minor code changes" doc
Update contributor docs to reflect the discussion of oslo library
usage at the 10 January 2019 Glance weekly meeting.

Change-Id: Ibb75ce0cbc2b906838a5149dc75bfb27383178a7
2019-01-10 11:46:46 -05:00
ZhongShengping
1058ad0a2d Update mailinglist from dev to discuss
openstack-dev was decomissioned this night in https://review.openstack.org/621258
Update openstack-dev to openstack-discuss

Change-Id: I6b5a3489c3e09bc1413dbac174310339151df05b
2018-12-05 09:44:29 +08:00
Brian Rosmaita
de6c36abaf Update "Release Notes" in contributor docs
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
2018-08-09 17:38:56 -04:00
Zuul
54329c6a21 Merge "Replace Chinese punctuation with English punctuation" 2018-06-20 17:22:14 +00:00
Brian Rosmaita
bc80aad4f3 Update Release CPL doc about periodic jobs
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
2018-06-07 13:34:47 +00:00
inspurericzhang
612e5cf12b Replace Chinese punctuation with English punctuation
Curly quotes(Chinese punctuation) usually input from Chinese input method.
When read from english context, it makes some confusion.

Change-Id: I9b8830179fb98f3a6bef479bbaa12df70311269a
2018-06-07 17:00:12 +08:00
Nguyen Hai
5e5ba92aec Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Remove the '[build_sphinx]' and [pbr] sections as described in:
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Adds the use of sphinxcontrib.apidoc to get (mostly) the same output as what
was provided by the removed [pbr] section.

Change-Id: Ie7e3acef7161cb8f218c2333167490c8116a2122
Depends-On: https://review.openstack.org/#/c/560270/
2018-04-11 06:02:54 +00:00
Brian Rosmaita
b13987cd41 Update Glance landing pages
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
2018-03-20 16:04:49 -04:00
Brian Rosmaita
8d53a388ba Update Release CPL doc
Remove an unnecessary task from post-release duties.

Change-Id: I0ef66a8ed79b53e1e741c291f303aa4cd8eda201
2018-03-09 11:02:55 -05:00
Abhishek Kekane
d500b3f883 Revise database rolling upgrade documentation
- 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
2018-02-20 15:47:58 -05:00
Nguyen Van Trung
97dbfb02d7 Add doc8 to pep8 check for glance project
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
2018-01-19 08:20:56 +00:00
Brian Rosmaita
d5eed8d745 Document new URL format
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
2017-10-20 15:07:54 -04:00
Brian Rosmaita
53ec4d5ab1 Document Glance Registry deprecation
Update the docs and add a release note.

Partially-implements: bp deprecate-registry

Change-Id: I759d38728a50ba516131e13745df651802fcce63
2017-10-19 10:31:27 -04:00
Brian Rosmaita
e6769aba8e Update spec-lite info in contributors' docs
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
2017-10-11 15:23:55 +00:00
Rui Yuan Dou
480722aeff Separate module reference from contributor/index page
Change-Id: I9acbbb32d83d194f8d827101a0604b45d61f96f7
2017-08-26 03:19:08 +08:00
Doug Hellmann
a2df410e76 fix the autodoc instructions
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>
2017-06-21 14:15:58 -04:00
Doug Hellmann
1c7f556d4f rearrange existing documentation to follow the new layout standard
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>
2017-06-21 14:15:58 -04:00