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

Bug #1558459 reported by Markus Zoeller (markus_z) on 2016-03-17
10
This bug affects 2 people
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Low
Elise Eiden

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

tags: added: doc low-hanging-fruit
Changed in nova:
status: New → Confirmed
importance: Undecided → Low
Gage Hugo (gagehugo) on 2016-03-17
Changed in nova:
assignee: nobody → Gage Hugo (gh159m)
description: updated

Fix proposed to branch: master
Review: https://review.openstack.org/294284

Changed in nova:
status: Confirmed → In Progress
tags: added: api-ref

Change abandoned by Gage Hugo (<email address hidden>) on branch: master
Review: https://review.openstack.org/294284
Reason: Going to abandon this due to inactivity, if someone wants to pick this up, feel free

Gage Hugo (gagehugo) on 2016-11-28
Changed in nova:
assignee: Gage Hugo (gagehugo) → nobody
Elise Eiden (ee550x) on 2016-11-28
Changed in nova:
assignee: nobody → Elise Eiden (ee550x)
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers