openstack/kolla-ansible
Code Issues Proposed changes

Fix doc format

Browse Source 
Get follwing error when running tox -edocs

doc/bifrost.rst:91: D001 Line too long
doc/manila-hnas-guide.rst:28: D000 Title underline too short.
doc/manila-hnas-guide.rst:28: D000 Title underline too short.
doc/networking-guide.rst:93: D000 Title underline too short.
doc/networking-guide.rst:93: D000 Title underline too short.
doc/multinode.rst:14: D001 Line too long
doc/quickstart.rst:474: D001 Line too long
doc/vagrant-dev-env.rst:129: D001 Line too long

Change-Id: I88090487a4710547224361d29aaf8371f8340c28
This commit is contained in:
Jeffrey Zhang 2017-02-15 12:17:12 +08:00
parent c028b6fdd1
commit 397d79c296
6 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/bifrost.rst
View File

@ -88,8 +88,8 @@ Prepare bifrost configs
Create servers.yml Create servers.yml
------------------ ------------------
The ``servers.yml`` will describing your physical nodes and list IPMI credentials. The ``servers.yml`` will describing your physical nodes and list IPMI
See bifrost dynamic inventory examples for more details. credentials. See bifrost dynamic inventory examples for more details.
For example ``/etc/kolla/config/bifrost/servers.yml`` For example ``/etc/kolla/config/bifrost/servers.yml``

2
doc/manila-hnas-guide.rst
View File

@ -25,7 +25,7 @@ Requirements
Supported shared file systems and operations Supported shared file systems and operations
------------------------------------------- --------------------------------------------
The driver supports CIFS and NFS shares. The driver supports CIFS and NFS shares.
The following operations are supported: The following operations are supported:

6
doc/multinode.rst
View File

@ -11,9 +11,9 @@ Deploy a registry
A Docker registry is a locally hosted registry that replaces the need to pull A Docker registry is a locally hosted registry that replaces the need to pull
from the Docker Hub to get images. Kolla can function with or without a local from the Docker Hub to get images. Kolla can function with or without a local
registry, however for a multinode deployment some type of registry is mandatory. registry, however for a multinode deployment some type of registry is
Only one registry must be deployed, although HA features exist for registry mandatory. Only one registry must be deployed, although HA features exist for
services. registry services.
The Docker registry prior to version 2.3 has extremely bad performance because The Docker registry prior to version 2.3 has extremely bad performance because
all container data is pushed for every image rather than taking advantage of all container data is pushed for every image rather than taking advantage of

2
doc/networking-guide.rst
View File

@ -90,7 +90,7 @@ For the source code, please refer to the following link:
Neutron VPNaaS (VPN-as-a-Service) Neutron VPNaaS (VPN-as-a-Service)
================================ =================================
Preparation and deployment Preparation and deployment
-------------------------- --------------------------

6
doc/quickstart.rst
View File

@ -469,9 +469,9 @@ View the images.
docker images docker images
Developers running from master are required to build container images as Developers running from master are required to build container images as the
the Docker Hub does not contain built images for the master branch. Docker Hub does not contain built images for the master branch. Reference the
Reference the `Building Container Images`_ for more advanced build configuration. `Building Container Images`_ for more advanced build configuration.
To build images using default parameters run: To build images using default parameters run:

4
doc/vagrant-dev-env.rst
View File

@ -126,8 +126,8 @@ Once logged on the **operator** VM call the ``kolla-build`` utility::
kolla-build kolla-build
``kolla-build`` accept arguments as documented in `Building Container Images`_. It ``kolla-build`` accept arguments as documented in `Building Container Images`_.
builds Docker images and pushes them to the local registry if the **push** It builds Docker images and pushes them to the local registry if the **push**
option is enabled (in Vagrant this is the default behaviour). option is enabled (in Vagrant this is the default behaviour).
Deploying OpenStack with Kolla Deploying OpenStack with Kolla