openstack/magnum
Code Issues Proposed changes

Fix doc format

Browse Source 
Blank line broke formatting in doc/source/user/index.rst. I therefore
deleted it.

Use code blocks instead of indentation in admin/magnum-proxy.rst
Old indentation was wrongly formated as quotation.

contributor/api-microversion.rst : Note was wrongly indented and
therefore interpreted as a quotation.

Change-Id: I47797a05be22a3b38f7994432ed75b67b6a4962a
This commit is contained in:
David Rabel 2018-06-28 12:42:49 +02:00
parent 1eb1f35a75
commit a400ea7980
3 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/admin/magnum-proxy.rst
View File

@ -40,7 +40,9 @@ Steps to configure proxies.
You can specify all three proxy parameters while creating ClusterTemplate of You can specify all three proxy parameters while creating ClusterTemplate of
any coe type. All of proxy parameters are optional. any coe type. All of proxy parameters are optional.
openstack coe cluster template create k8s-cluster-template \ .. code-block:: console
$ openstack coe cluster template create k8s-cluster-template \
--image fedora-atomic-latest \ --image fedora-atomic-latest \
--keypair testkey \ --keypair testkey \
--external-network public \ --external-network public \
@ -50,7 +52,10 @@ any coe type. All of proxy parameters are optional.
--http-proxy <http://abc-proxy.com:8080> \ --http-proxy <http://abc-proxy.com:8080> \
--https-proxy <https://abc-proxy.com:8080> \ --https-proxy <https://abc-proxy.com:8080> \
--no-proxy <172.24.4.4,172.24.4.9,172.24.4.8> --no-proxy <172.24.4.4,172.24.4.9,172.24.4.8>
openstack coe cluster template create swarm-cluster-template \
.. code-block:: console
$ openstack coe cluster template create swarm-cluster-template \
--image fedora-atomic-latest \ --image fedora-atomic-latest \
--keypair testkey \ --keypair testkey \
--external-network public \ --external-network public \
@ -60,7 +65,10 @@ any coe type. All of proxy parameters are optional.
--http-proxy <http://abc-proxy.com:8080> \ --http-proxy <http://abc-proxy.com:8080> \
--https-proxy <https://abc-proxy.com:8080> \ --https-proxy <https://abc-proxy.com:8080> \
--no-proxy <172.24.4.4,172.24.4.9,172.24.4.8> --no-proxy <172.24.4.4,172.24.4.9,172.24.4.8>
openstack coe cluster template create mesos-cluster-template \
.. code-block:: console
$ openstack coe cluster template create mesos-cluster-template \
--image ubuntu-mesos \ --image ubuntu-mesos \
--keypair testkey \ --keypair testkey \
--external-network public \ --external-network public \

4
doc/source/contributor/api-microversion.rst
View File

@ -165,8 +165,8 @@ we need a microversion".
url/resource that does not exist always fails with 404. Invalid content types url/resource that does not exist always fails with 404. Invalid content types
are handled before API methods are called which results in a 415. are handled before API methods are called which results in a 415.
.. note:: When in doubt about whether or not a microversion is required .. note:: When in doubt about whether or not a microversion is required
for changing an error response code, consult the `Containers Team`_. for changing an error response code, consult the `Containers Team`_.
.. _Containers Team: https://wiki.openstack.org/wiki/Meetings/Containers .. _Containers Team: https://wiki.openstack.org/wiki/Meetings/Containers

1
doc/source/user/index.rst
View File

@ -1417,7 +1417,6 @@ Storage driver (docker-storage-driver)
This is currently not supported for Mesos. This is currently not supported for Mesos.
Image (image) Image (image)
Specified in the ClusterTemplate to indicate the image to boot the servers Specified in the ClusterTemplate to indicate the image to boot the servers
for the Mesos master and slave. The image binary is loaded in for the Mesos master and slave. The image binary is loaded in
Glance with the attribute 'os_distro = ubuntu'. You can download Glance with the attribute 'os_distro = ubuntu'. You can download