The RST image directive takes an alt parameter that's used to supply an
alt attribute for the HTML image element that's generated during RST
to HTML conversion. The alt text is useful for accessibility purposes
and is also displayed if the image source is unavailable when the HTML
is generated. Because of the latter point, we can't rely on the
accessibility features of the SVG image, we need to maintain some info
here in the README.rst file.
Change-Id: I1ca4a4d84cbb87c696b98d2d1d14f9ef792fcff6
README.rst file for functional tests and glanceclient itself
raises some warnings when passing these docs through REST
validator and build the doc:
- Need additional empty line to provide correct indent in
cloud.yaml example
- Title should be with the same length as overline.
The patch fixes these warnings.
Change-Id: I2e2ef6f838ee639d1a88256b6e321181a62cc76b
The README file needs to have links to the project documentation and bug
tracker in a parsable format in order for some of the release tools
scripts to work (particularly the one that prints the release note
email).
Change-Id: I37e0acc5ed8e1af565359290fa622456901c735e
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.
Change-Id: Id72a42c640b02df3991bafc369ffc38aad1135d4
* The index page is now a set of release notes and a quickstart guide
* Shrink the README (pypi doc page) and move it into the doc site
* Drop the link to the autoindex module docs
Change-Id: I276b1228ba4006279c112eb487dcde9e45c4f344
Copied mostly from python-keystoneclient with
some Glance-specific stuff. README.rst shows what
WILL be the way to do things, not what is currently coded :)
Brian Rosmaita