Update documentation to remove broken links and refer to the correct …

…minimum pymongo version
ansible-collections · Jun 27, 2024 · bac0532 · bac0532
1 parent 0636590
commit bac0532
Show file tree

Hide file tree

Showing 19 changed files with 33 additions and 33 deletions.
diff --git a/docs/mongodb_module.template.py b/docs/mongodb_module.template.py
@@ -25,8 +25,8 @@
     default: <DEFAULT>
 
 notes:
-- Requires the pymongo Python package on the remote host, version 2.4.2+. This
-  can be installed using pip or the OS package manager. @see U(http://api.mongodb.org/python/current/installation.html)
+- Requires the pymongo Python package on the remote host, version 4+. This
+  can be installed using pip or the OS package manager. @see U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/)
 requirements:
 - pymongo
 '''

diff --git a/plugins/cache/mongodb.py b/plugins/cache/mongodb.py
@@ -129,7 +129,7 @@ def _manage_indexes(self, collection):
     def _collection(self):
         '''
         This is a context manager for opening and closing mongo connections as needed. This exists as to not create a global
-        connection, due to pymongo not being fork safe (http://api.mongodb.com/python/current/faq.html#is-pymongo-fork-safe)
+        connection, due to pymongo not being fork safe (https://www.mongodb.com/docs/languages/python/pymongo-driver/current/faq/#is-pymongo-fork-safe-)
         '''
         mongo = pymongo.MongoClient(self._connection)
         try:

diff --git a/plugins/lookup/mongodb.py b/plugins/lookup/mongodb.py
@@ -73,11 +73,11 @@
         description:
             - Extra connection parameters that to be sent to pymongo.MongoClient
             - Check the example to see how to connect to mongo using an SSL certificate.
-            - "All possible parameters are here: U(https://api.mongodb.com/python/current/api/pymongo/mongo_client.html#pymongo.mongo_client.MongoClient)"
+            - "All possible parameters are here: U(https://pymongo.readthedocs.io/en/stable/api/pymongo/mongo_client.html#pymongo.mongo_client.MongoClient)"
         type: dict
         default: {}
 notes:
-    - "Please check https://api.mongodb.org/python/current/api/pymongo/collection.html?highlight=find#pymongo.collection.Collection.find for more details."
+    - "Please check https://pymongo.readthedocs.io/en/stable/api/pymongo/collection.html#pymongo.collection.Collection.find for more details."
 requirements:
     - pymongo >= 2.4 (python library)
 '''

diff --git a/plugins/modules/mongodb_balancer.py b/plugins/modules/mongodb_balancer.py
@@ -65,8 +65,8 @@
     type: raw
     required: false
 notes:
-  - Requires the pymongo Python package on the remote host, version 2.4.2+. This
-    can be installed using pip or the OS package manager. @see U(http://api.mongodb.org/python/current/installation.html)
+  - Requires the pymongo Python package on the remote host, version 4+. This
+    can be installed using pip or the OS package manager. @see U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/)
 requirements:
   - pymongo
 '''

diff --git a/plugins/modules/mongodb_index.py b/plugins/modules/mongodb_index.py
@@ -39,7 +39,7 @@
       - Replica set to connect to (automatically connects to primary for writes).
     type: str
 notes:
-    - Requires the pymongo Python package on the remote host, version 2.4.2+.
+    - Requires the pymongo Python package on the remote host, version 4+.
 
 requirements:
   - pymongo

diff --git a/plugins/modules/mongodb_info.py b/plugins/modules/mongodb_info.py
@@ -38,7 +38,7 @@
     elements: str
 
 notes:
-    - Requires the pymongo Python package on the remote host, version 2.4.2+.
+    - Requires the pymongo Python package on the remote host, version 4+.
 
 requirements:
   - pymongo

diff --git a/plugins/modules/mongodb_maintenance.py b/plugins/modules/mongodb_maintenance.py
@@ -29,8 +29,8 @@
     type: bool
     default: false
 notes:
-  - Requires the pymongo Python package on the remote host, version 2.4.2+. This
-    can be installed using pip or the OS package manager. @see U(http://api.mongodb.org/python/current/installation.html)
+  - Requires the pymongo Python package on the remote host, version 4+. This
+    can be installed using pip or the OS package manager. @see U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/)
 requirements:
   - pymongo
 '''

diff --git a/plugins/modules/mongodb_oplog.py b/plugins/modules/mongodb_oplog.py
@@ -38,8 +38,8 @@
     default: false
     required: false
 notes:
-  - Requires the pymongo Python package on the remote host, version 2.4.2+. This
-    can be installed using pip or the OS package manager. @see U(http://api.mongodb.org/python/current/installation.html)
+  - Requires the pymongo Python package on the remote host, version 4+. This
+    can be installed using pip or the OS package manager. @see U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/)
 requirements:
   - pymongo
 '''

diff --git a/plugins/modules/mongodb_parameter.py b/plugins/modules/mongodb_parameter.py
@@ -46,9 +46,9 @@
         choices: [int, str]
 
 notes:
-    - Requires the pymongo Python package on the remote host, version 2.4.2+.
+    - Requires the pymongo Python package on the remote host, version 4+.
     - This can be installed using pip or the OS package manager.
-    - See also U(http://api.mongodb.org/python/current/installation.html)
+    - See also U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/)
 requirements: [ "pymongo" ]
 author: "Loic Blot (@nerzhul)"
 '''

diff --git a/plugins/modules/mongodb_replicaset.py b/plugins/modules/mongodb_replicaset.py
@@ -111,8 +111,8 @@
       - hello
     default: hello
 notes:
-- Requires the pymongo Python package on the remote host, version 2.4.2+. This
-  can be installed using pip or the OS package manager. @see U(http://api.mongodb.org/python/current/installation.html)
+- Requires the pymongo Python package on the remote host, version 4+. This
+  can be installed using pip or the OS package manager. @see U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/)
 requirements:
 - pymongo
 '''

diff --git a/plugins/modules/mongodb_role.py b/plugins/modules/mongodb_role.py
@@ -79,9 +79,9 @@
     default: false
     type: bool
 notes:
-    - Requires the pymongo Python package on the remote host, version 2.4.2+. This
+    - Requires the pymongo Python package on the remote host, version 4+. This
       can be installed using pip or the OS package manager. Newer mongo server versions require newer
-      pymongo versions. @see http://api.mongodb.org/python/current/installation.html
+      pymongo versions. @see https://www.mongodb.com/docs/languages/python/pymongo-driver/current/compatibility/
 requirements:
   - "pymongo"
 author:

diff --git a/plugins/modules/mongodb_schema.py b/plugins/modules/mongodb_schema.py
@@ -84,7 +84,7 @@
     default: false
 
 notes:
-    - Requires the pymongo Python package on the remote host, version 2.4.2+.
+    - Requires the pymongo Python package on the remote host, version 4+.
 
 requirements:
   - pymongo

diff --git a/plugins/modules/mongodb_shard.py b/plugins/modules/mongodb_shard.py
@@ -54,7 +54,7 @@
       - "present"
 
 notes:
-    - Requires the pymongo Python package on the remote host, version 2.4.2+.
+    - Requires the pymongo Python package on the remote host, version 4+.
 requirements: [ pymongo ]
 '''
 

diff --git a/plugins/modules/mongodb_shard_tag.py b/plugins/modules/mongodb_shard_tag.py
@@ -49,8 +49,8 @@
     type: str
     default: "mongos"
 notes:
-  - Requires the pymongo Python package on the remote host, version 2.4.2+. This
-    can be installed using pip or the OS package manager. @see U(http://api.mongodb.org/python/current/installation.html)
+  - Requires the pymongo Python package on the remote host, version 4+. This
+    can be installed using pip or the OS package manager. @see U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/)
 requirements:
   - pymongo
 '''

diff --git a/plugins/modules/mongodb_shard_zone.py b/plugins/modules/mongodb_shard_zone.py
@@ -54,8 +54,8 @@
     type: str
     default: "mongos"
 notes:
-  - Requires the pymongo Python package on the remote host, version 2.4.2+. This
-    can be installed using pip or the OS package manager. @see U(http://api.mongodb.org/python/current/installation.html)
+  - Requires the pymongo Python package on the remote host, version 4+. This
+    can be installed using pip or the OS package manager. @see U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/)
 requirements:
   - pymongo
 '''

diff --git a/plugins/modules/mongodb_shutdown.py b/plugins/modules/mongodb_shutdown.py
@@ -33,8 +33,8 @@
     type: int
     default: 10
 notes:
-- Requires the pymongo Python package on the remote host, version 2.4.2+. This
-  can be installed using pip or the OS package manager. @see U(http://api.mongodb.org/python/current/installation.html)
+- Requires the pymongo Python package on the remote host, version 4+. This
+  can be installed using pip or the OS package manager. @see U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/)
 requirements:
   - pymongo
 '''

diff --git a/plugins/modules/mongodb_status.py b/plugins/modules/mongodb_status.py
@@ -57,8 +57,8 @@
        - minimal
     default: default
 notes:
-- Requires the pymongo Python package on the remote host, version 2.4.2+. This
-  can be installed using pip or the OS package manager. @see U(http://api.mongodb.org/python/current/installation.html)
+- Requires the pymongo Python package on the remote host, version 4+. This
+  can be installed using pip or the OS package manager. @see U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/)
 requirements:
 - pymongo
 '''

diff --git a/plugins/modules/mongodb_stepdown.py b/plugins/modules/mongodb_stepdown.py
@@ -52,8 +52,8 @@
     type: bool
     default: false
 notes:
-  - Requires the pymongo Python package on the remote host, version 2.4.2+. This
-    can be installed using pip or the OS package manager. @see U(http://api.mongodb.org/python/current/installation.html)
+  - Requires the pymongo Python package on the remote host, version 4+. This
+    can be installed using pip or the OS package manager. @see U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/)
 requirements:
   - pymongo
 '''

diff --git a/plugins/modules/mongodb_user.py b/plugins/modules/mongodb_user.py
@@ -79,9 +79,9 @@
       - If this file is present (and C(login_user) is not defined), then skip this task.
 
 notes:
-    - Requires the pymongo Python package on the remote host, version 2.4.2+. This
+    - Requires the pymongo Python package on the remote host, version 4+. This
       can be installed using pip or the OS package manager. Newer mongo server versions require newer
-      pymongo versions. @see http://api.mongodb.org/python/current/installation.html
+      pymongo versions. @see https://www.mongodb.com/docs/languages/python/pymongo-driver/current/compatibility/
 requirements:
   - "pymongo"
 author: