openstack
/
glance-specs
Code Issues Proposed changes

spelling error 

fixing the double-quote chars in the RST source to be regular double-quotes

Change-Id: Iaeb652d63d093091af9f321e421fd082948c5614
This commit is contained in:
melissaml 2018-03-08 16:24:54 +08:00
parent 449947b209
commit 6b6424f392
10 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
specs/kilo/artifact-repository.rst
View File

@ -217,7 +217,7 @@ at any time - their value is set automatically by the repository.
- Immutable - Immutable
- Yes - Yes
- String following the SemVer notation - String following the SemVer notation
- Defines the version of the artifact. See “Artifact versioning” section - Defines the version of the artifact. See "Artifact versioning" section
below for the details. below for the details.
* - Description * - Description
- Mutable - Mutable
@ -241,7 +241,7 @@ at any time - their value is set automatically by the repository.
- N/A - N/A
- Enum, any of: CREATING, ACTIVE, DEACTIVATED, DELETED - Enum, any of: CREATING, ACTIVE, DEACTIVATED, DELETED
- A system field set by the repository, indicating the current phase of - A system field set by the repository, indicating the current phase of
the artifact's lifecycle. See “Artifact Lifecyle” below for details the artifact's lifecycle. See "Artifact Lifecyle" below for details
* - Owner * - Owner
- System - System
- N/A - N/A
@ -291,13 +291,13 @@ the following properties:
The following types are supported: The following types are supported:
* *String* - simple string value (255 characters max). In listing queries * *String* - simple string value (255 characters max). In listing queries
may use this field to filter artifacts by value equality (e.g. “filter all may use this field to filter artifacts by value equality (e.g. "filter all
the artifacts of type ‘Image’ having the field ‘OS_TYPE’ equal to the artifacts of type ‘Image’ having the field ‘OS_TYPE’ equal to
‘Linux’”) ‘Linux’")
* *Integer*. - integer field. In listing queries may use this field to * *Integer*. - integer field. In listing queries may use this field to
filter artifacts by both value equality and value range (e.g. “filter all filter artifacts by both value equality and value range (e.g. "filter all
the artifacts of type ‘Image’ having the field ‘REQUIRED_RAM’ less or equal the artifacts of type ‘Image’ having the field ‘REQUIRED_RAM’ less or equal
to 16”) to 16")
* *Numeric* - same as Integer, but stored as Numeric * *Numeric* - same as Integer, but stored as Numeric
* *Boolean** - boolean values, having either 'True' or 'False' as the value. * *Boolean** - boolean values, having either 'True' or 'False' as the value.
In listing queries may use this field to filter artifacts by value equality. In listing queries may use this field to filter artifacts by value equality.
@ -383,8 +383,8 @@ images are stored independently from their definitions in the current version
of Glance. of Glance.
When the artifact is initially created in the repository (the record is When the artifact is initially created in the repository (the record is
inserted into the database), it is in the CREATING state (see the “Artifact inserted into the database), it is in the CREATING state (see the "Artifact
Lifecycle” section below) and has no binary data associated. Then - before Lifecycle" section below) and has no binary data associated. Then - before
publishing the artifact - its owner may upload the data by using the publishing the artifact - its owner may upload the data by using the
appropriate API calls or specify the location/uri of the existing binary blob appropriate API calls or specify the location/uri of the existing binary blob
pre-uploaded to some back-end storage. pre-uploaded to some back-end storage.
@ -412,8 +412,8 @@ binary object associated.
This means that each artifact may have a number of different BLOBs associated. This means that each artifact may have a number of different BLOBs associated.
The amount of blobs and their types (“Heat template”, "Provider Templates" and The amount of blobs and their types ("Heat template", "Provider Templates" and
“Icon” in the example above) are defined per each artifact type. When the "Icon" in the example above) are defined per each artifact type. When the
artifact is in CREATING state its owner will have to upload all the required artifact is in CREATING state its owner will have to upload all the required
parts one-by-one, specifying their types every time. If some required blob is parts one-by-one, specifying their types every time. If some required blob is
not uploaded, the "publishing check" will not pass and the artifact will not be not uploaded, the "publishing check" will not pass and the artifact will not be
@ -441,9 +441,9 @@ properties:
If set to None, then the number of blobs in BLOBs list per If set to None, then the number of blobs in BLOBs list per
artifact has no upper bound. artifact has no upper bound.
*For example, the above-mentioned artifact type “Heat template” may define *For example, the above-mentioned artifact type "Heat template" may define
an optional BinaryObjectList property with the Name set to “ProviderTemplate”, an optional BinaryObjectList property with the Name set to "ProviderTemplate",
and a required BinaryObjectList property with the name “Icon” and minimum and a required BinaryObjectList property with the name "Icon" and minimum
and maximum length constraints equal to 1. and maximum length constraints equal to 1.
This means that the artifacts of this type have to contain exactly one icon This means that the artifacts of this type have to contain exactly one icon
blob and zero or more provider template blobs.* blob and zero or more provider template blobs.*
@ -452,7 +452,7 @@ The repository provides an API call to inspect the blob contents of each
artifact. artifact.
*In the example above the API returns a dictionary containing two *In the example above the API returns a dictionary containing two
keys: “ProviderTemplates” and “Icon”. The first key defined a list of keys: "ProviderTemplates" and "Icon". The first key defined a list of
records, each one corresponding to a different blob with a provider template, records, each one corresponding to a different blob with a provider template,
the second one defines a single record corresponding to the blob with the the second one defines a single record corresponding to the blob with the
icon. Each of the blob records contains an id of the particular blob, which icon. Each of the blob records contains an id of the particular blob, which
@ -499,8 +499,8 @@ editing.
The dependencies cannot be circular (e.g if A depends on B, B depends on C and The dependencies cannot be circular (e.g if A depends on B, B depends on C and
C depends on D, then D cannot depend on A), and the published artifact may not C depends on D, then D cannot depend on A), and the published artifact may not
depend on an artifact being in a “CREATING” state. For example, if A depends depend on an artifact being in a "CREATING" state. For example, if A depends
on B and both are in “CREATING” state, then B should be published before A, on B and both are in "CREATING" state, then B should be published before A,
otherwise the publishing check of A will fail. otherwise the publishing check of A will fail.
The dependencies may be created only on the artifacts which belong to the same The dependencies may be created only on the artifacts which belong to the same

2
specs/newton/approved/glance/glare-api.rst
View File

@ -185,7 +185,7 @@ glossary and list of Use Cases.
* *Artifact Blob* - property type that defines binary data for Artifact. * *Artifact Blob* - property type that defines binary data for Artifact.
User can download Artifact blob from Glare. Each blob property has a flag User can download Artifact blob from Glare. Each blob property has a flag
*external*, that indicates if the property was created during file upload *external*, that indicates if the property was created during file upload
(False) or by direct user request (True). In other words, “external” means (False) or by direct user request (True). In other words, "external" means
that blob property url is just a reference to some external file and Glare that blob property url is just a reference to some external file and Glare
does not manage the blob operations in that case. does not manage the blob operations in that case.
Json schema that defines blob format: Json schema that defines blob format:

2
specs/newton/approved/python-glanceclient/lite-specs.rst
View File

@ -25,7 +25,7 @@ Optionals (please remove this line and fill or remove the rest until End of Temp
:timeline: <Estimation of the time needed to complete the work.> :timeline: <Estimation of the time needed to complete the work.>
:link: <Link to the change in gerrit that already would provide the `solution`. :link: <Link to the change in gerrit that already would provide the `solution`.
After commiting the Spec Lite depend the change to the Spec Lite commit.> After committing the Spec Lite depend the change to the Spec Lite commit.>
:reviewers: <If reviewers has been agreed for the functionality, list them here.> :reviewers: <If reviewers has been agreed for the functionality, list them here.>

4
specs/ocata/approved/glance/rolling-upgrades.rst
View File

@ -63,8 +63,8 @@ listed in [GOV1]_. They are:
This plan should clearly call out the supported configuration(s) that This plan should clearly call out the supported configuration(s) that
are expected to work, unless there are no such caveats. This does not are expected to work, unless there are no such caveats. This does not
require complete elimination of downtime during upgrades, but rather require complete elimination of downtime during upgrades, but rather
reducing the scope from “all services” to “some services at a time.” In reducing the scope from "all services" to "some services at a time." In
other words, “restarting all API services together” is a reasonable other words, "restarting all API services together" is a reasonable
restriction. restriction.
The Glance services consist of the Glance API server and the optional The Glance services consist of the Glance API server and the optional

2
specs/ocata/approved/glance_store/lite-specs.rst
View File

@ -25,7 +25,7 @@ Optionals (please remove this line and fill or remove the rest until End of Temp
:timeline: <Estimation of the time needed to complete the work.> :timeline: <Estimation of the time needed to complete the work.>
:link: <Link to the change in gerrit that already would provide the `solution`. :link: <Link to the change in gerrit that already would provide the `solution`.
After commiting the Spec Lite depend the change to the Spec Lite commit.> After committing the Spec Lite depend the change to the Spec Lite commit.>
:reviewers: <If reviewers has been agreed for the functionality, list them here.> :reviewers: <If reviewers has been agreed for the functionality, list them here.>

2
specs/ocata/approved/python-glanceclient/lite-specs.rst
View File

@ -25,7 +25,7 @@ Optionals (please remove this line and fill or remove the rest until End of Temp
:timeline: <Estimation of the time needed to complete the work.> :timeline: <Estimation of the time needed to complete the work.>
:link: <Link to the change in gerrit that already would provide the `solution`. :link: <Link to the change in gerrit that already would provide the `solution`.
After commiting the Spec Lite depend the change to the Spec Lite commit.> After committing the Spec Lite depend the change to the Spec Lite commit.>
:reviewers: <If reviewers has been agreed for the functionality, list them here.> :reviewers: <If reviewers has been agreed for the functionality, list them here.>

2
specs/pike/approved/glance/lite-specs.rst
View File

@ -25,7 +25,7 @@ Optionals (please remove this line and fill or remove the rest until End of Temp
:timeline: <Estimation of the time needed to complete the work.> :timeline: <Estimation of the time needed to complete the work.>
:link: <Link to the change in gerrit that already would provide the `solution`. :link: <Link to the change in gerrit that already would provide the `solution`.
After commiting the Spec Lite depend the change to the Spec Lite commit.> After committing the Spec Lite depend the change to the Spec Lite commit.>
:reviewers: <If reviewers has been agreed for the functionality, list them here.> :reviewers: <If reviewers has been agreed for the functionality, list them here.>

2
specs/pike/approved/glance_store/lite-specs.rst
View File

@ -25,7 +25,7 @@ Optionals (please remove this line and fill or remove the rest until End of Temp
:timeline: <Estimation of the time needed to complete the work.> :timeline: <Estimation of the time needed to complete the work.>
:link: <Link to the change in gerrit that already would provide the `solution`. :link: <Link to the change in gerrit that already would provide the `solution`.
After commiting the Spec Lite depend the change to the Spec Lite commit.> After committing the Spec Lite depend the change to the Spec Lite commit.>
:reviewers: <If reviewers has been agreed for the functionality, list them here.> :reviewers: <If reviewers has been agreed for the functionality, list them here.>

2
specs/pike/approved/python-glanceclient/lite-specs.rst
View File

@ -25,7 +25,7 @@ Optionals (please remove this line and fill or remove the rest until End of Temp
:timeline: <Estimation of the time needed to complete the work.> :timeline: <Estimation of the time needed to complete the work.>
:link: <Link to the change in gerrit that already would provide the `solution`. :link: <Link to the change in gerrit that already would provide the `solution`.
After commiting the Spec Lite depend the change to the Spec Lite commit.> After committing the Spec Lite depend the change to the Spec Lite commit.>
:reviewers: <If reviewers has been agreed for the functionality, list them here.> :reviewers: <If reviewers has been agreed for the functionality, list them here.>

2
specs/spec-lite-template.rst
View File

@ -33,7 +33,7 @@ Spec Lite: <Your Title Here>
:timeline: <List the milestone by which you expect this work to be completed.> :timeline: <List the milestone by which you expect this work to be completed.>
:link: <Link to the change in gerrit that already would provide the `solution`. :link: <Link to the change in gerrit that already would provide the `solution`.
After commiting the Spec Lite depend the change to the Spec Lite commit.> After committing the Spec Lite depend the change to the Spec Lite commit.>
:reviewers: <If specific reviewers have agreed to champion this proposal, list :reviewers: <If specific reviewers have agreed to champion this proposal, list
them here.> them here.>