summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSandra McCann <samccann@redhat.com>2023-02-10 20:18:02 -0500
committerGitHub <noreply@github.com>2023-02-10 17:18:02 -0800
commitea9db2b4410ee71d4616ea8ad309114308b10988 (patch)
tree28e42521d6d81bfbb008b104ab26688258d46719 /docs
parent9e507faea51d48595bd4ff9b622d5583bf31d0fe (diff)
downloadansible-ea9db2b4410ee71d4616ea8ad309114308b10988.tar.gz
Backportapalooza 02 09 (#79962)
* make this a warning, not a comment (#79928) Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com> (cherry picked from commit 5f947f867cc526a43c3070a4a9ae380c385edb1d) * Update example to always init ANOTHER_LIBRARY_IMPORT_ERROR (#79927) (cherry picked from commit 24519f3bd1b23bc89a968383f54a8b1fe708e3af) * Rst fixes (#79939) * fix rstcheck errors for 6.1.1 * spell shell correctly (cherry picked from commit dc990058201d63df685e83a316cf3402242ff1b4) * Update dnf.py (#79679) (cherry picked from commit 0ab53aefc94afa3829676d25f732526773d31d0a) * Change `yes` to `true` in uri-module (#79934) (cherry picked from commit b5ff981369dd926f6ecf135a90f9b4f8375fb6c4) --------- Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com> Co-authored-by: Matt Martz <matt@sivel.net> Co-authored-by: Bartłomiej Kida <wireboot@gmail.com> Co-authored-by: Sebastian Gumprich <rndmh3ro@users.noreply.github.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/docsite/rst/dev_guide/developing_collections_shared.rst2
-rw-r--r--docs/docsite/rst/dev_guide/testing/sanity/import.rst1
-rw-r--r--docs/docsite/rst/dev_guide/testing_units_modules.rst4
-rw-r--r--docs/docsite/rst/network/getting_started/first_playbook.rst4
4 files changed, 6 insertions, 5 deletions
diff --git a/docs/docsite/rst/dev_guide/developing_collections_shared.rst b/docs/docsite/rst/dev_guide/developing_collections_shared.rst
index bddb94c9e6..34db6aea69 100644
--- a/docs/docsite/rst/dev_guide/developing_collections_shared.rst
+++ b/docs/docsite/rst/dev_guide/developing_collections_shared.rst
@@ -78,7 +78,7 @@ You can use git repositories for collection dependencies during local developmen
dependencies: {'git@github.com:organization/repo_name.git': 'devel'}
-.. warning
+.. warning::
Do not use git repositories as dependencies for published collections. Dependencies for published collections must be other published collections.
diff --git a/docs/docsite/rst/dev_guide/testing/sanity/import.rst b/docs/docsite/rst/dev_guide/testing/sanity/import.rst
index 118b3d97ed..6a5d329450 100644
--- a/docs/docsite/rst/dev_guide/testing/sanity/import.rst
+++ b/docs/docsite/rst/dev_guide/testing/sanity/import.rst
@@ -28,6 +28,7 @@ Instead of using ``import another_library``:
ANOTHER_LIBRARY_IMPORT_ERROR = traceback.format_exc()
else:
HAS_ANOTHER_LIBRARY = True
+ ANOTHER_LIBRARY_IMPORT_ERROR = None
.. note::
diff --git a/docs/docsite/rst/dev_guide/testing_units_modules.rst b/docs/docsite/rst/dev_guide/testing_units_modules.rst
index 5b24d49220..d07dcff944 100644
--- a/docs/docsite/rst/dev_guide/testing_units_modules.rst
+++ b/docs/docsite/rst/dev_guide/testing_units_modules.rst
@@ -388,8 +388,8 @@ Here is a simple mock of :meth:`AnsibleModule.run_command` (taken from :file:`te
with patch.object(basic.AnsibleModule, 'run_command') as run_command:
run_command.return_value = 0, '', '' # successful execution, no output
- with self.assertRaises(AnsibleExitJson) as result:
- my_module.main()
+ with self.assertRaises(AnsibleExitJson) as result:
+ my_module.main()
self.assertFalse(result.exception.args[0]['changed'])
# Check that run_command has been called
run_command.assert_called_once_with('/usr/bin/command args')
diff --git a/docs/docsite/rst/network/getting_started/first_playbook.rst b/docs/docsite/rst/network/getting_started/first_playbook.rst
index 2c06ded742..15a4ed16f5 100644
--- a/docs/docsite/rst/network/getting_started/first_playbook.rst
+++ b/docs/docsite/rst/network/getting_started/first_playbook.rst
@@ -91,7 +91,7 @@ The playbook sets three of the seven values from the command line above: the gro
The playbook contains one play with two tasks, and should generate output like this:
-.. code-block:: bash
+.. code-block:: shell
$ ansible-playbook -i vyos.example.net, -u ansible -k -e ansible_network_os=vyos.vyos.vyos first_playbook.yml
@@ -115,7 +115,7 @@ The playbook contains one play with two tasks, and should generate output like t
The extended first playbook has five tasks in a single play. Run it with the same command you used above. The output shows you the change Ansible made to the config:
-.. code-block:: bash
+.. code-block:: shell
$ ansible-playbook -i vyos.example.net, -u ansible -k -e ansible_network_os=vyos.vyos.vyos first_playbook_ext.yml