yahoo-eng-team team mailing list archive

[OpenStack Infra <1558459@xxxxxxxxxxxxxxxxxx>]

Reviewed:  https://review.openstack.org/615809
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=ddf7c6e370f71741794b88297aaa43aaed9df6c4
Submitter: Zuul
Branch:    master

commit ddf7c6e370f71741794b88297aaa43aaed9df6c4
Author: Takashi NATSUME <natsume.takashi@xxxxxxxxxxxxx>
Date:   Tue Nov 6 17:57:31 2018 +0900

    Improve formats of the Compute API guide
    
    Replace the 'NOTE' and 'TODO' words with
    the note and todo directives in the Compute API guide.
    
    Improve some format in the guide.
    e.g. Fix unnecessary bold characters.
    
    Change-Id: I7e9d6b8a5228886fd5de03d12482481d2b652666
    Closes-Bug: #1558459


** Changed in: nova
       Status: In Progress => Fix Released

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Compute (nova).
https://bugs.launchpad.net/bugs/1558459

Title:
  api-guide: server concepts: multiple format and style issues

Status in OpenStack Compute (nova):
  Fix Released

Bug description:
  This bug reports is based on [1]. The "server concepts" page of the
  "api guide" [2] has multiple format and style issues:

  *    The code blocks are not correctly indented under their bullet points.
  *    The "Example ..." texts are rendered within the previous code blocks.
  *    The continuous texts (like "there are 2 servers existing ...") are placed within the code blocks.
  *    For reasons I don't get the last 2 code examples are rendered with an orange color font.
  *    Bullet point "Resource Optimization" has an unintentional quote due to a missing space
  *   <super-picky-mode>The json examples could be within "code-block:: json" to be more specific as json looks very similar to   python dicts but is more sensitive when it comes to validation </super-picky-mode>

  Nova version:
  Seen with commit 230958c002736444bfb36c9f0845f4f4e5253d0e

  References:
  [1] https://review.openstack.org/#/c/292137/5
  [2] http://developer.openstack.org/api-guide/compute/server_concepts.html

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