Run checkniceness/doc8 against security-guide-rst

Previously we weren't running doc8 against
security-guide-rst which means that it wasn't being checked.

This fix also required changing 4 of the rst files already
merged as they had incidents of line-length exceeding the
maximum, which is now caught by doc8.

Once the conversion is complete this entry must be reversed
as the project will be renamed.

Signed-off-by: Dave Walker (Daviey) <email@daviey.com>
Change-Id: Iebceeeac67406519a49a8f892f636919efc114c3
This commit is contained in:
Dave Walker (Daviey)
2015-07-22 09:31:23 +01:00
parent 722c855c07
commit 76fc5b582f
5 changed files with 14 additions and 7 deletions

View File

@@ -2,7 +2,8 @@
Case studies Case studies
============ ============
.. TODO (elmiko) fixup the introduction chapter link to point to case studies intro .. TODO (elmiko) fixup the introduction chapter link to point to case studies
intro
Continuing with the studies described in :doc:`../introduction`, we Continuing with the studies described in :doc:`../introduction`, we
present Alice and Bob's approaches to deploying the Data present Alice and Bob's approaches to deploying the Data

View File

@@ -15,7 +15,8 @@ TLS
The Data processing service controller, like many other OpenStack The Data processing service controller, like many other OpenStack
controllers, can be configured to require TLS connections. controllers, can be configured to require TLS connections.
.. TODO (elmiko) fixup secure communication chapter link to point to tls proxies section .. TODO (elmiko) fixup secure communication chapter link to point to tls
proxies section
Pre-Kilo releases will require a TLS proxy as the controller does not Pre-Kilo releases will require a TLS proxy as the controller does not
allow direct TLS connections. Configuring TLS proxies is allow direct TLS connections. Configuring TLS proxies is
@@ -90,7 +91,8 @@ used if requested, or an automated option exists which instructs the
service to create a security group based on ports specified by the service to create a security group based on ports specified by the
framework being accessed. framework being accessed.
.. TODO (elmiko) fixup networking chapter link to point to security groups section .. TODO (elmiko) fixup networking chapter link to point to security groups
section
For production environments we recommend controlling the security For production environments we recommend controlling the security
groups manually and creating a set of group rules that are appropriate groups manually and creating a set of group rules that are appropriate

View File

@@ -2,7 +2,8 @@
Case studies Case studies
============ ============
.. TODO (elmiko) fixup the introduction chapter link to point to case studies intro .. TODO (elmiko) fixup the introduction chapter link to point to case studies
intro
Earlier in :doc:`../introduction` we introduced the Alice and Bob case Earlier in :doc:`../introduction` we introduced the Alice and Bob case
studies where Alice is deploying a private government cloud and Bob is studies where Alice is deploying a private government cloud and Bob is
@@ -14,7 +15,8 @@ instance migrations.
Alice's private cloud Alice's private cloud
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
.. TODO (elmiko) fixup the management chapter link to point to case studies section .. TODO (elmiko) fixup the management chapter link to point to case studies
section
Earlier in :doc:`../management`, Earlier in :doc:`../management`,
Alice issued a Request for Product (or RFP) to major hardware Alice issued a Request for Product (or RFP) to major hardware

View File

@@ -286,7 +286,8 @@ following lines to the nova :file:`policy.json` file:
Migration network Migration network
----------------- -----------------
.. TODO (elmiko) fixup introduction doc link to point to the security boundaries and threats section .. TODO (elmiko) fixup introduction doc link to point to the security
boundaries and threats section
As a general practice, live migration traffic should be restricted As a general practice, live migration traffic should be restricted
to the management security domain, see :doc:`../introduction`. to the management security domain, see :doc:`../introduction`.

View File

@@ -25,6 +25,7 @@ commands = openstack-doc-test --check-links {posargs}
commands = commands =
openstack-doc-test --check-niceness {posargs} openstack-doc-test --check-niceness {posargs}
doc8 -e '' security-notes doc8 -e '' security-notes
doc8 -e '' security-guide-rst
[testenv:checksyntax] [testenv:checksyntax]
commands = commands =
@@ -84,7 +85,7 @@ commands =
[doc8] [doc8]
# Settings for doc8: # Settings for doc8:
# This file has extra long lines that cannot be avoided, let's white list it. # This file has extra long lines that cannot be avoided, let's white list it.
ignore-path = security-notes/OSSN-0047,doc/security-guide-rst/source/imported ignore-path = security-notes/OSSN-0047,security-guide-rst/source/imported
# File extensions to use # File extensions to use
extensions = .rst,.txt extensions = .rst,.txt
# Disable some doc8 checks: # Disable some doc8 checks: