snooty.toml

name = "compass"
title = "MongoDB Compass"

intersphinx = [
    "https://www.mongodb.com/docs/manual/objects.inv",
    "https://www.mongodb.com/docs/database-tools/objects.inv",
    "https://www.mongodb.com/docs/mongodb-shell/objects.inv",
    "https://www.mongodb.com/docs/atlas/objects.inv"
]

toc_landing_pages = [
    "/install",
    "/install/verify-signatures",  
    "/connect",
    "/settings",
    "/settings/config-file",
    "/connect/advanced-connection-options",
    "/connect/favorite-connections",
    "/connect/favorite-connections/import-export",
    "/indexes",
    "/instance", 
    "/config-file",
    "/query/filter",
    "/query-with-natural-language/query-with-natural-language",
    "/query/queries",
    "/documents", 
    "/schema", 
    "/performance",
    "/create-agg-pipeline", 
    "/collections"
]

[constants]
download-page = "`downloads page <https://www.mongodb.com/try/download/compass>`__"
current-version = "1.44.5"
atlas = "MongoDB Atlas"
qe = "Queryable Encryption"
qe-preview = "{+qe+} Public Preview"
qe-equality-ga = "{+qe+} with equality queries"

[[banners]]
targets = [
    "connect/in-use-encryption.txt",
    "in-use-encryption-tutorial.txt",
    "collections/encrypted-collection.txt",
]

variant = "warning"
value = """
    {+qe-equality-ga+} is generally available (GA) in MongoDB 7.0 and \
    later. The {+qe-preview+}, released in version 6.0, is no longer supported. \
    Data encrypted using the Public Preview is incompatible with the feature release. \
    For more information, see :ref:`7.0-compatibility`.
    """

[substitutions]
atlas = "MongoDB Atlas"
compass = "MongoDB Compass"
compass-short = "Compass"
sql = ":abbr:`SQL (Structured Query Language)`"
service = "Atlas"
json = ":abbr:`JSON (Javascript Object Notation)`"
bson = ":abbr:`BSON (Binary Javascript Object Notation)`"
checkmark = "√"