yahoo-eng-team team mailing list archive

[Brian Rosmaita <rosmaita.fossdev@xxxxxxxxx>]

Public bug reported:

The "Disk and container formats for images" section of the "VM Image
Guide" in the openstack-manuals repo has gotten out date with respect to
Glance image format changes.  Additionally, it duplicates some
information from documentation maintained by the Glance team.

To make the docs easier to maintain, we should make these changes:

(1) rewrite the Introduction page of the VM Image Guide so that it
discusses the concept of "container format" and "disk format".  Don't
discuss the set of identifiers that Glance recognizes in the manual;
instead, give a link to the appropriate place in the glance docs.
Remove the two sub-pages (image-formats.rst and image-metadata.rst).

(2) merge the content from openstack-manuals/image-formats.rst and
openstack-manuals/image-metadata.rst into docs/user/formats.rst in the
glance repo

** Affects: glance
     Importance: Low
     Assignee: Brian Rosmaita (brian-rosmaita)
         Status: Triaged

** Affects: openstack-manuals
     Importance: Undecided
     Assignee: Brian Rosmaita (brian-rosmaita)
         Status: In Progress

** Also affects: openstack-manuals
   Importance: Undecided
       Status: New

** Changed in: openstack-manuals
     Assignee: (unassigned) => Brian Rosmaita (brian-rosmaita)

** Changed in: openstack-manuals
       Status: New => In Progress

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to Glance.
https://bugs.launchpad.net/bugs/1842343

Title:
  docs: move image formats doc to glance repo

Status in Glance:
  Triaged
Status in openstack-manuals:
  In Progress

Bug description:
  The "Disk and container formats for images" section of the "VM Image
  Guide" in the openstack-manuals repo has gotten out date with respect
  to Glance image format changes.  Additionally, it duplicates some
  information from documentation maintained by the Glance team.

  To make the docs easier to maintain, we should make these changes:

  (1) rewrite the Introduction page of the VM Image Guide so that it
  discusses the concept of "container format" and "disk format".  Don't
  discuss the set of identifiers that Glance recognizes in the manual;
  instead, give a link to the appropriate place in the glance docs.
  Remove the two sub-pages (image-formats.rst and image-metadata.rst).

  (2) merge the content from openstack-manuals/image-formats.rst and
  openstack-manuals/image-metadata.rst into docs/user/formats.rst in the
  glance repo

To manage notifications about this bug go to:
https://bugs.launchpad.net/glance/+bug/1842343/+subscriptions