Chapter 41. Lists inside lists should not all use commas

Bug #1342432 reported by N Dillon
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-manuals
Fix Released
Low
Andreas Jaeger

Bug Description

When using multiple lists (such as a, b, and c1, c2, and c3) the delimeter should not all be commas (and remove 'we' reference):

Doc Currently Reads: "For the reasons stated above, it is important to take proactive steps to harden QEMU. We recommend three specific steps: minimizing the code base, using compiler hardening, and using mandatory access controls, such as sVirt, SELinux, or AppArmor."

Recommended change: "Therefore, it is important to take proactive steps to harden QEMU. Three specific steps are recommended: minimizing the code base, using compiler hardening, and using mandatory access controls such as sVirt; SELinux; or AppArmor."

Alternatively, it could be a bulleted list with sub-bullets
1) minimize code base
2) use compiler hardening
3) user mandatory access controls, such as:
    -sVirt
    -SELinux
    -AppArmor

-----------------------------------
Built: 2014-07-15T19:04:59 00:00
git SHA: f7711cc343e504283676dfe43afae6faa9046fd7
URL: http://docs.openstack.org/security-guide/content/hardening-the-virtualization-layers.html
source File: file:/home/jenkins/workspace/security-doc-tox-doc-publishdocs/security-guide/ch_hardening-the-virtualization-layers.xml
xml:id: hardening-the-virtualization-layers

Revision history for this message
Gauvain Pocentek (gpocentek) wrote :

I'm not sure that we use the semicolon to separate list items. The bullet list seems a better option.

Changed in openstack-manuals:
status: New → Confirmed
importance: Undecided → Low
Changed in openstack-manuals:
assignee: nobody → Andreas Jaeger (jaegerandi)
Changed in openstack-manuals:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to security-doc (master)

Reviewed: https://review.openstack.org/113142
Committed: https://git.openstack.org/cgit/openstack/security-doc/commit/?id=733e5a8ca50a12c55be046b84b9e8db3bda2ad14
Submitter: Jenkins
Branch: master

commit 733e5a8ca50a12c55be046b84b9e8db3bda2ad14
Author: Andreas Jaeger <email address hidden>
Date: Sun Aug 10 20:09:22 2014 +0200

    Improve "Hardening the virtualization layer"

    Various edits as suggested in bug reports:
    * Use variablelist to follow conventions for markup, improve paragraph
      for clarity.
    * Clarify a sentence about SELinux.
    * Improve CFLAGS recommendation.
    * Reword QEMU recommendation.

    Change-Id: I28fdb67a9103e3263944a3b22a44cfc16917473e
    Closes-Bug: #1342862
    Closes-Bug: #1342829
    Closes-Bug: #1342826
    Closes-Bug: #1342432

Changed in openstack-manuals:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.