Public bug reported: This bug reports is based on [1]. The "server concepts" page of the "api guide" 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 ** Affects: nova Importance: Low Status: Confirmed ** Tags: doc low-hanging-fruit ** Tags added: doc low-hanging-fruit ** Changed in: nova Status: New => Confirmed ** Changed in: nova Importance: Undecided => Low -- 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): Confirmed Bug description: This bug reports is based on [1]. The "server concepts" page of the "api guide" 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 -- Mailing list: https://launchpad.net/~yahoo-eng-team Post to : [email protected] Unsubscribe : https://launchpad.net/~yahoo-eng-team More help : https://help.launchpad.net/ListHelp
