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>
As we are removing the s3 driver from source tree per change
I032b0fc16400cbd2112687d38e010128be699221 , it seems right to remove the
references of the same in the glance tree.
Updated here are files that referenced s3; these files include:
* documentation files
* documentation of the glance architecture (source and png files)
* config help text
* stores associated with location strategy
* tests
UpgradeImpact
Change-Id: I680ee2baf39b49156d173e2ae108ae5d0221eca7
Depends-On: I032b0fc16400cbd2112687d38e010128be699221
Depends-On: I5d2da0611365b838f41285b64cdcfef9adf50e85
In order to accomodate developers with screen readers, alt text
has been modified to provide an accurate and full description of
the diagrams in the documentation. Screen readers use the
alt text as a description of an image.
Change-Id: I6343c6d9d980331ef2b0f4f23b1fa2d37b0ba602
Closes-Bug: 1432214
There are many warnings and errors that occur when the docs are
generated.
Co-Author-By: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
Closes-Bug: 1556818
Change-Id: Ifebeb3904f136a56bd6fe6877220b279a1f98354
Wikipedia's list of common misspellings [1] has a machine-readable
version. This patch fixes those misspellings mentioned in the list
which don't have multiple right variants (as e.g. "accension", which can
be both "accession" and "ascension"), such misspellings are left
untouched. The list of changes was manually re-checked for false
positives.
[1] https://en.wikipedia.org/wiki/Wikipedia:Lists_of_common_misspellings/For_machines
Change-Id: I6f549eb78998ead9b2f1a04e196e65b3f08f1be7
Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
Adds a basic architecture description section
to the Glance Developer guide.
Change-Id: I782490bb8757cd67d83057176f8e3eeffa007b84
Co-Authored-By: Mike Fedosin <mfedosin@mirantis.com>
Co-Authored-By: Olena Logvinova <ologvinova@mirantis.com>
Co-Authored-By: Alexander Adamov <aadamov@mirantis.com>
* Rewords how we refer to to our 'reference' implementation of the registry
API. glance-registry is an implementation detail of the main glance API, not
an example of a community-driven API spec
* Remove duplicate 'gettingstarted' information
* Fixes bug 954554
Change-Id: I889f61a399c398897f2146b756b2c3c310847718
Doug Hellmann