From 6f73ab84c6741e321d2a297e08db64a481d931c0 Mon Sep 17 00:00:00 2001 From: Sam Doran Date: Wed, 28 Jun 2017 05:06:56 -0400 Subject: [PATCH] Correct note syntax so Docker on non-Linux note shows up (#26161) The note only had one colon instead of two, which allowed it to pass rstcheck but failed to actually generate the note in the HTML. Also remove an unnecessary trailing colon. --- docs/docsite/rst/dev_guide/testing_integration.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docsite/rst/dev_guide/testing_integration.rst b/docs/docsite/rst/dev_guide/testing_integration.rst index 9539378b440..5741fb23dbd 100644 --- a/docs/docsite/rst/dev_guide/testing_integration.rst +++ b/docs/docsite/rst/dev_guide/testing_integration.rst @@ -45,7 +45,7 @@ outside of those test subdirectories. They will also not reconfigure or bounce To protect your system from any potential changes caused by integration tests, and to ensure the a sensible set of dependencies are available we recommend that you always run integration tests with the ``--docker`` option. See the `list of supported docker images `_ for options. -.. note:: Avoiding pulling new Docker images: +.. note:: Avoiding pulling new Docker images Use the ``--docker-no-pull`` option to avoid pulling the latest container image. This is required when using custom local images that are not available for download. @@ -98,9 +98,9 @@ Tests in Docker containers If you have a Linux system with Docker installed, running integration tests using the same Docker containers used by the Ansible continuous integration (CI) system is recommended. -.. note: Docker on non-Linux:: +.. note:: Docker on non-Linux - Using Docker Engine to run Docker on a non-Linux host is not recommended. + Using Docker Engine to run Docker on a non-Linux (such as macOS) host is not recommended. Some tests may fail, depending on the image used for testing. Using the ``--docker-privileged`` option may resolve the issue.