Skip to content

Commit 0bd1313

Browse files
committed
docs: minor fixes to external Ceph guide
When a path is broken into two separate lines, the generated HTML includes an incorrect space character in the middle of the path. We need to ignore doc8 linting on this file as this change breaks the max line length check. I tried using ``ignore-path-errors`` to exclude only D001 for this file, but doc8 does not like a relative path for this option [1]. [1] PyCQA/doc8#162 Change-Id: I1cf0b7a6b7506a68876bce2de5080718280a47be
1 parent 7f85bea commit 0bd1313

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

doc/source/reference/storage/external-ceph-guide.rst

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -211,8 +211,7 @@ Cinder for Ceph includes following steps:
211211

212212
* ``/etc/kolla/config/cinder/cinder-volume/ceph.client.cinder.keyring``
213213
* ``/etc/kolla/config/cinder/cinder-backup/ceph.client.cinder.keyring``
214-
* ``/etc/kolla/config/cinder/cinder-backup/
215-
ceph.client.cinder-backup.keyring``
214+
* ``/etc/kolla/config/cinder/cinder-backup/ceph.client.cinder-backup.keyring``
216215

217216
.. note::
218217

@@ -281,8 +280,7 @@ the use with availability zones:
281280
* ``/etc/kolla/config/cinder/cinder-volume/ceph1.client.cinder.keyring``
282281
* ``/etc/kolla/config/cinder/cinder-backup/ceph1.client.cinder.keyring``
283282
* ``/etc/kolla/config/cinder/cinder-backup/ceph2.client.cinder.keyring``
284-
* ``/etc/kolla/config/cinder/cinder-backup/
285-
ceph2.client.cinder-backup.keyring``
283+
* ``/etc/kolla/config/cinder/cinder-backup/ceph2.client.cinder-backup.keyring``
286284

287285
.. note::
288286

@@ -296,8 +294,8 @@ Nova must also be configured to allow access to Cinder volumes:
296294
* ``/etc/kolla/config/nova/ceph.conf``
297295
* ``/etc/kolla/config/nova/ceph.client.cinder.keyring``
298296

299-
To configure ``different Ceph backend`` for nova-compute host, which
300-
is useful for the use with availability zones:
297+
To configure different Ceph backends for nova-compute hosts, which is useful
298+
for use with availability zones:
301299

302300
* Edit inventory file in the way described below:
303301

@@ -364,8 +362,8 @@ Configuring Nova for Ceph includes following steps:
364362
keys for Cinder and Nova, you will need to override
365363
``ceph_nova_user`` to match.
366364

367-
To configure ``different Ceph backend`` for nova-compute host, which
368-
is useful for the use with availability zones:
365+
To configure different Ceph backends for nova-compute hosts, which is useful
366+
for use with availability zones:
369367

370368
Edit inventory file in the way described below:
371369

tox.ini

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,11 @@ show-source = True
126126
ignore = W504
127127
exclude = .eggs,.git,.tox,doc
128128

129+
[doc8]
130+
# NOTE(priteau): We break max line length in this file to avoid inserting
131+
# erroneous space characters inside file paths
132+
ignore-path = doc/source/reference/storage/external-ceph-guide.rst
133+
129134
[testenv:doc8]
130135
deps = {[testenv:linters]deps}
131136
commands =

0 commit comments

Comments
 (0)