ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Correct note syntax so Docker on non-Linux note shows up (#26161)

Browse source 
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.
This commit is contained in:
Sam Doran 2017-06-28 05:06:56 -04:00 committed by John R Barker
parent 9a88c157ec
commit 6f73ab84c6
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/docsite/rst/dev_guide/testing_integration.rst
View file

@ -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 <https://github.com/ansible/ansible/blob/devel/test/runner/completion/docker.txt>`_ for options. 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 <https://github.com/ansible/ansible/blob/devel/test/runner/completion/docker.txt>`_ 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. 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 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. 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. Some tests may fail, depending on the image used for testing.
Using the ``--docker-privileged`` option may resolve the issue. Using the ``--docker-privileged`` option may resolve the issue.