Grammatical Errors - Chapter 2. System documentation requirements in OpenStack Security Guide - current

[Shellee Aragon]

Incomplete sentence, does not articulate point of topic properly:

For example, compute nodes, storage nodes, and network devices that exist on the network but that might not be adequately protected and/or forgotten.

Proposed revision – merge the 1st part with the previous sentence and re-writing the context as shown below:

By leveraging a CMDB, an organization can quickly identify cloud infrastructure hardware such as compute nodes, storage nodes, or network devices. A CMDB can assist in identifying assets existing on the network which may have vulnerabilities due to inadequate protection or being displaced and forgotten.

Improper use of punctuation - Run on sentence:

Just as with hardware, all software components within the OpenStack deployment should be documented. Components here should include system databases; OpenStack software components and supporting sub-components; and, supporting infrastructure software such as load-balancers, reverse proxies, and network address translators. Having an authoritative list like this may be critical toward understanding total system impact due to a compromise or vulnerability of a specific class of software.

Proposed Revision:

Similar to treatment of hardware, all software components
All software components within an OpenStack deployment should be documented. Components should be inclusive of:

• System Databases
• OpenStack software components
              >Supporting sub-components
• Supporting Infrastructure software
              >Load-balancers
              >Reverse Proxies
              >Network Address Translators

Implementation of an authoritative list may be critical toward understanding total system impact due to a compromise or vulnerability of a specific class of software.

-----------------------------------
Built: 2014-07-17T17:41:53 00:00
git SHA: c14f57c7e299c76ed1e8f26f02a4a4892657a3eb
URL: http://docs.openstack.org/security-guide/content/system-documentation-requirements.html
source File: file:/home/jenkins/workspace/security-doc-tox-doc-publishdocs/security-guide/ch_system-documentation-requirements.xml
xml:id: system-documentation-requirements

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

commit b6895c81a209b922a6c844de7ed0fc1c7a41e4a2
Author: Shellee Arnold <email address hidden>
Date: Thu Feb 19 09:11:55 2015 -0800

    Fixes for grammatical errors

    Fixes for incomplete sentence and articulation of topic.

    Closes Bug: #1343523

    Change-Id: I943e562462fa4b7f7b7b8b3777aa205f095dad92