DOCSP-41464-dump-export-mongodb-only-notice (#165)

* DOCSP-41464-dump-export-mongodb-only-notice * * * * * * * * * * * * * * * * * * * * * * * * * * * *
mongodb · Aug 6, 2024 · 34357c3 · 34357c3
1 parent 239bec8
commit 34357c3
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/snooty.toml b/snooty.toml
@@ -73,3 +73,19 @@ section = 1
 file = "mongotop.txt"
 title = "mongotop"
 section = 1
+
+[[banners]]
+# Warning for non-genuine deployment usage with tool binaries.
+targets = [
+        "mongodump.txt",
+        "mongorestore.txt",
+        "mongoimport.txt",
+        "mongoexport.txt",
+        "mongotop.txt",
+        "mongostat.txt",
+        "mongofiles.txt"
+        ]
+variant = "warning"
+value = """\
+        MongoDB Command Line Database Tool binaries are not supported or tested for use with non-genuine MongoDB deployments. While the tools may work on these deployments, compatibility is not guaranteed.
+        """
diff --git a/source/mongodump.txt b/source/mongodump.txt
@@ -1,8 +1,8 @@
 .. _mongodump:
 
-=========
-mongodump
-=========
+=============
+``mongodump``
+=============
 
 .. default-domain:: mongodb