From 0a02db56b5801bb6b8391c445abe9edbd5b1589c Mon Sep 17 00:00:00 2001 From: Sarah Olson <98367156+sarah-olson-mongodb@users.noreply.github.com> Date: Wed, 4 May 2022 13:03:06 -0700 Subject: [PATCH] PR for DOCSP-20352 Subdomain consolidation (#1032) * DOCSP-20352: Update intersphix links * DOCSP-20352: Update readme file with new link structure * DOCSP-20352: Update contributing.rst with new link structure. * DOCSP-20352: Update redirects file * DOCSP-20352: Update some links * DOCSP-20352: More subdomain link edits * DOCSP-20352: Subdomain link updates * DOCSP-20352: Subdomain link updates * DOCSP-20352: Delete conf-sitemap * DOCSP-20352: One more link * Update source/includes/driver-examples/driver-example-insert-2.rst Co-authored-by: jeff-allen-mongo * Update source/includes/list-table-products-supported-architecture.rst Co-authored-by: jeff-allen-mongo * Update source/includes/list-table-products-supported-architecture.rst Co-authored-by: jeff-allen-mongo * Update source/includes/list-table-products-supported-architecture.rst Co-authored-by: jeff-allen-mongo * Update source/reference/program.txt Co-authored-by: jeff-allen-mongo * Update source/tutorial/analyze-query-plan.txt Co-authored-by: jeff-allen-mongo * Update source/tutorial/manage-client-side-encryption-data-keys.txt Co-authored-by: jeff-allen-mongo * DOCSP-20352: Fix role typo "DOCSP-20352: Resolve merge conflicts" * DOCSP-20352: More link edits * DOCSP-20352: Build testing * DOCSP-20352: Link format testing * DOCSP-20352: Test link format * DOCSP-20352: Minor format edit * DOCSP-20352: Minor format edit * DOCSP-20352: Minor format edit * DOCSP-20352: Minor format edit * Update source/.static/osd.xml Co-authored-by: Allison Reinheimer Moore * DOCSP-20352: Review feedback * DOCSP-20352: Fix two minor errors Co-authored-by: Sarah Olson Co-authored-by: jeff-allen-mongo Co-authored-by: Allison Reinheimer Moore --- CONTRIBUTING.rst | 12 ++++---- README.rst | 2 +- conf-sitemap.xml | 30 ------------------- config/build_conf.yaml | 2 +- config/redirects | 26 ++++++++-------- snooty.toml | 10 +++---- source/.static/osd.xml | 6 ++-- source/about.txt | 10 +++---- source/administration/production-notes.txt | 2 +- source/changeStreams.txt | 4 +-- source/contents.txt | 2 +- source/core/kerberos.txt | 2 +- source/core/retryable-reads.txt | 4 +-- .../core/security-client-side-encryption.txt | 6 ++-- .../driver-example-indexes-1.rst | 4 +-- .../driver-example-insert-2.rst | 2 +- .../driver-example-query-intro.rst | 4 +-- .../fact-uuid-restore-from-backup.rst | 2 +- source/includes/list-4.2-drivers.rst | 2 +- ...-table-products-supported-architecture.rst | 8 ++--- .../includes/upgrade-guidance-checklists.rst | 4 +-- source/index.txt | 14 ++++----- source/query-api.txt | 4 +-- ...-settings-command-line-options-mapping.txt | 6 ++-- source/reference/configuration-options.txt | 6 ++-- source/reference/database-references.txt | 2 +- source/reference/log-messages.txt | 8 ++--- source/reference/mongodb-defaults.txt | 26 +++++++--------- source/reference/program.txt | 6 ++-- source/reference/program/mongo.txt | 2 +- source/reference/versioning.txt | 11 ++++--- .../4.2-downgrade-replica-set.txt | 4 +-- .../4.2-downgrade-sharded-cluster.txt | 4 +-- .../4.2-downgrade-standalone.txt | 4 +-- source/release-notes/4.4.txt | 9 ++---- source/tutorial/analyze-query-plan.txt | 10 +++---- source/tutorial/authenticate-a-user.txt | 3 +- ...up-sharded-cluster-with-database-dumps.txt | 6 ++-- source/tutorial/configure-ssl-clients.txt | 2 +- source/tutorial/install-mongodb-on-os-x.txt | 11 +++---- ...anage-client-side-encryption-data-keys.txt | 7 ++--- source/tutorial/manage-indexes.txt | 2 +- source/tutorial/query-documents.txt | 10 +++---- source/tutorial/remove-documents.txt | 10 +++---- source/tutorial/restore-sharded-cluster.txt | 6 ++-- source/tutorial/update-documents.txt | 13 ++++---- 46 files changed, 139 insertions(+), 191 deletions(-) delete mode 100644 conf-sitemap.xml diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 52cdfcaaa9d..383263550b4 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -3,9 +3,9 @@ Contributing to the MongoDB Documentation Project ================================================= We welcome your contributions to the MongoDB documentation project. -The primary site is http://docs.mongodb.org/ and translated versions +The primary site is https://www.mongodb.com/docs/ and translated versions of the site are listed in `MongoDB Manual Translation -`_. +`_. MongoDB documentation is distributed under a `Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported`_ license. MongoDB, @@ -19,10 +19,10 @@ pull request. Please review the following documents for our style, conventions, processes and practices for the MongoDB Documentation: -- `Style Guide `_ -- `Documentation Practices `_ -- `Documentation Organization `_ -- `Documentation Build Tools `_ +- `Style Guide `_ +- `Documentation Practices `_ +- `Documentation Organization `_ +- `Documentation Build Tools `_ Do not hesitate to open a ticket in our `Jira`_ project or to contact the `documentation team`_ diff --git a/README.rst b/README.rst index 8463101c180..ceac9b5dc7a 100644 --- a/README.rst +++ b/README.rst @@ -3,7 +3,7 @@ MongoDB Documentation ===================== This repository contains a major revision of the MongoDB documentation, -currently accessible at http://docs.mongodb.com/manual/. You can build +currently accessible at https://www.mongodb.com/docs/manual/. You can build the documentation locally if you have `giza `_ installed: :: diff --git a/conf-sitemap.xml b/conf-sitemap.xml deleted file mode 100644 index eceeee594d8..00000000000 --- a/conf-sitemap.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - diff --git a/config/build_conf.yaml b/config/build_conf.yaml index 9dfed986ce2..11837f7b730 100644 --- a/config/build_conf.yaml +++ b/config/build_conf.yaml @@ -5,7 +5,7 @@ git: project: name: 'manual' tag: 'manual' - url: 'https://docs.mongodb.com' + url: 'https://www.mongodb.com/docs' title: 'MongoDB Manual' branched: true siteroot: true diff --git a/config/redirects b/config/redirects index 03136909d42..044d37a1841 100644 --- a/config/redirects +++ b/config/redirects @@ -1047,18 +1047,18 @@ raw: ${prefix}/master/release-notes/3.3-dev-series-reference -> ${base}/master/r [v2.2]: ${prefix}/${version}/MongoDB-manual-v2.2.pdf -> ${base}/${version}/meta/pdfs/ [v2.2]: ${prefix}/${version}/MongoDB-reference-manual-v2.2.pdf -> ${base}/${version}/meta/pdfs/ [v2.2]: ${prefix}/${version}/MongoDB-crud-guide-v2.2.pdf -> ${base}/${version}/meta/pdfs/ -(v3.0-*]: ${prefix}/${version}/products/bi-connector -> https://docs.mongodb.com/bi-connector/ +(v3.0-*]: ${prefix}/${version}/products/bi-connector -> https://www.mongodb.com/docs/bi-connector/ (v3.0-*]: ${prefix}/${version}/reference/business-intelligence-programs -> ${base}/bi-connector/ -(v3.0-*]: ${prefix}/${version}/products/faq-bi-connector -> https://docs.mongodb.com/bi-connector/faq/ -(v3.0-*]: ${prefix}/${version}/products/components-bi-connector -> https://docs.mongodb.com/bi-connector/components/ -(v3.0-*]: ${prefix}/${version}/products/release-notes/bi-connector -> https://docs.mongodb.com/bi-connector/release-notes/ -(v3.0-*]: ${prefix}/${version}/reference/program/mongobischema -> https://docs.mongodb.com/bi-connector/reference/mongobischema/ -(v3.0-*]: ${prefix}/${version}/reference/program/mongobiuser -> https://docs.mongodb.com/bi-connector/reference/mongobiuser/ -(v3.0-*]: ${prefix}/${version}/reference/program/mongodrdl -> https://docs.mongodb.com/bi-connector/reference/mongodrdl/ -(v3.0-*]: ${prefix}/${version}/products/compass -> https://docs.mongodb.com/compass/ +(v3.0-*]: ${prefix}/${version}/products/faq-bi-connector -> https://www.mongodb.com/docs/bi-connector/faq/ +(v3.0-*]: ${prefix}/${version}/products/components-bi-connector -> https://www.mongodb.com/docs/bi-connector/components/ +(v3.0-*]: ${prefix}/${version}/products/release-notes/bi-connector -> https://www.mongodb.com/docs/bi-connector/release-notes/ +(v3.0-*]: ${prefix}/${version}/reference/program/mongobischema -> https://www.mongodb.com/docs/bi-connector/reference/mongobischema/ +(v3.0-*]: ${prefix}/${version}/reference/program/mongobiuser -> https://www.mongodb.com/docs/bi-connector/reference/mongobiuser/ +(v3.0-*]: ${prefix}/${version}/reference/program/mongodrdl -> https://www.mongodb.com/docs/bi-connector/reference/mongodrdl/ +(v3.0-*]: ${prefix}/${version}/products/compass -> https://www.mongodb.com/docs/compass/ [*]: ${prefix}/${version}/products -> ${base}/${version}/ -(v3.0-*]: ${prefix}/${version}/products/cloud-manager -> https://docs.cloud.mongodb.com/ -(v3.0-*]: ${prefix}/${version}/products/ops-manager -> https://docs.opsmanager.mongodb.com/current/ +(v3.0-*]: ${prefix}/${version}/products/cloud-manager -> https://www.mongodb.com/docs/cloud-manager/ +(v3.0-*]: ${prefix}/${version}/products/ops-manager -> https://www.mongodb.com/docs/ops-manager/current/ (v2.6-*]: ${prefix}/${version}/reference/command/getoptime -> ${base}/${version}/reference/command/nav-replication/ (v2.6-*]: ${prefix}/${version}/reference/command/closeAllDatabases -> ${base}/${version}/reference/command/nav-administration/ [*-v2.6]: ${prefix}/${version}/reference/operator/aggregation/dateToString -> ${base}/${version}/reference/operator/aggregation/ @@ -1084,9 +1084,9 @@ raw: ${prefix}/master/release-notes/3.3-dev-series-reference -> ${base}/master/r (v2.6-*]: ${prefix}/${version}/tutorial/backup-with-mongodump -> ${base}/${version}/tutorial/backup-and-restore-tools/ [*-v2.6]: ${prefix}/${version}/tutorial/backup-and-restore-tools -> ${base}/${version}/tutorial/backup-with-mongodump/ [*-v2.6]: ${prefix}/${version}/administration/analyzing-mongodb-performance -> ${base}/${version}/administration/optimization/ -raw: ${prefix}/master/tutorial/generate-test-data -> http://docs.mongodb.com/getting-started/shell/ -raw: ${prefix}/manual/tutorial/generate-test-data -> http://docs.mongodb.com/getting-started/shell/ -[v3.0]: ${prefix}/${version}/tutorial/generate-test-data -> ${base}/${version}http://docs.mongodb.com/getting-started/shell/ +raw: ${prefix}/master/tutorial/generate-test-data -> https://www.mongodb.com/docs/getting-started/shell/ +raw: ${prefix}/manual/tutorial/generate-test-data -> https://www.mongodb.com/docs/getting-started/shell/ +[v3.0]: ${prefix}/${version}/tutorial/generate-test-data -> https://www.mongodb.com/docs/getting-started/shell/ (v2.4-*]: ${prefix}/${version}/reference/transparent-huge-pages -> ${base}/${version}/tutorial/transparent-huge-pages/ [*-v2.2]: ${prefix}/${version}/tutorial/transparent-huge-pages -> ${base}/${version}/administration/production-notes/ [*-v3.0]: ${prefix}/${version}/tutorial/perform-findAndModify-quorum-reads -> ${base}/${version}/reference/method/db.collection.findAndModify/ diff --git a/snooty.toml b/snooty.toml index 85db924de2d..7804dd10ed3 100644 --- a/snooty.toml +++ b/snooty.toml @@ -5,11 +5,11 @@ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/" intersphinx = [ "https://pymongo.readthedocs.io/en/stable/objects.inv", "https://motor.readthedocs.io/en/stable/objects.inv", - "https://docs.atlas.mongodb.com/objects.inv", - "https://docs.mongodb.com/php-library/master/objects.inv", - "https://docs.mongodb.com/compass/current/objects.inv", - "https://docs.mongodb.com/database-tools/objects.inv", - "https://docs.mongodb.com/mongodb-shell/objects.inv" + "https://www.mongodb.com/docs/atlas/objects.inv", + "https://www.mongodb.com/docs/php-library/upcoming/objects.inv", + "https://www.mongodb.com/docs/compass/current/objects.inv", + "https://www.mongodb.com/docs/database-tools/objects.inv", + "https://www.mongodb.com/docs/mongodb-shell/objects.inv" ] # toc_landing_pages are pages that have pages nested beneath them diff --git a/source/.static/osd.xml b/source/.static/osd.xml index 92a92376f31..82212ae1bed 100644 --- a/source/.static/osd.xml +++ b/source/.static/osd.xml @@ -5,9 +5,9 @@ Google Custom Search of MongoDB documentation (docs.mongodb.com) mongodb mongo mongodocs -https://docs.mongodb.com/favicon.ico +https://www.mongodb.com/docs/favicon.ico MongoDB, Inc. sitesearch@mongodb.com - - + + diff --git a/source/about.txt b/source/about.txt index 2feafeebeb4..9de02ad7b1e 100644 --- a/source/about.txt +++ b/source/about.txt @@ -12,7 +12,7 @@ About MongoDB Documentation :depth: 1 :class: singlecol -`The MongoDB Manual `_ contains +The :manual:`MongoDB Manual ` contains comprehensive documentation on MongoDB. This page describes the manual's licensing, editions, and versions, and describes how to make a change request and how to contribute to the manual. @@ -29,7 +29,7 @@ Attribution-NonCommercial-ShareAlike 3.0 United States License Man Pages --------- -In addition to the `MongoDB Manual `_, you can +In addition to the :manual:`MongoDB Manual `, you can access the :manual:`MongoDB Man Pages `, which are also distributed with the official MongoDB Packages. @@ -39,14 +39,14 @@ Version and Revisions This version of the manual reflects version {+latest-lts-version+} of MongoDB. -See the `MongoDB Documentation Project Page `_ +See the `MongoDB Documentation Project Page `_ for an overview of all editions and output formats of the MongoDB Manual. You can see the full revision history and track ongoing improvements and additions for all versions of the manual from its `GitHub repository `_. The most up-to-date, current, and stable version of the manual is -always available at "https://docs.mongodb.com/manual/". +always available at "https://www.mongodb.com/docs/manual/". Report an Issue or Make a Change Request ---------------------------------------- @@ -92,7 +92,7 @@ necessary Sphinx extensions and build tools, are available in the same repository as the documentation. For more information on the MongoDB documentation process, see the -`Meta Documentation `__. +`Meta Documentation `__. If you have any questions, please feel free to open a :issue:`Jira Case `. diff --git a/source/administration/production-notes.txt b/source/administration/production-notes.txt index 69392f1ee99..a4237087fc2 100644 --- a/source/administration/production-notes.txt +++ b/source/administration/production-notes.txt @@ -127,7 +127,7 @@ current stable release, even if you are installing via a package manager. For other MongoDB products, refer either to the :dl:`MongoDB Download Center <>` -page or their `respective documentation `_. +page or their `respective documentation `_. MongoDB ``dbPath`` ------------------ diff --git a/source/changeStreams.txt b/source/changeStreams.txt index a7c3eb9754b..2948d5d044c 100644 --- a/source/changeStreams.txt +++ b/source/changeStreams.txt @@ -241,7 +241,7 @@ upper-right to set the language of the examples on this page. :tabid: php The examples below assume that you have `connected to a MongoDB replica set and have accessed a database - `__ + `__ that contains an ``inventory`` collection. .. literalinclude:: /driver-examples/DocumentationExamplesTest.php @@ -254,7 +254,7 @@ upper-right to set the language of the examples on this page. :tabid: ruby The examples below assume that you have `connected to a MongoDB replica set and have accessed a database - `__ + `__ that contains an ``inventory`` collection. diff --git a/source/contents.txt b/source/contents.txt index 820fd2206e6..b1a07168546 100644 --- a/source/contents.txt +++ b/source/contents.txt @@ -33,7 +33,7 @@ project, this Manual and additional editions of this text. Introduction Installation - MongoDB Shell (mongosh) + MongoDB Shell (mongosh) /crud /aggregation /data-modeling diff --git a/source/core/kerberos.txt b/source/core/kerberos.txt index 61250e2368b..476d8ae0c4b 100644 --- a/source/core/kerberos.txt +++ b/source/core/kerberos.txt @@ -198,7 +198,7 @@ The following MongoDB drivers support Kerberos authentication: - `Perl `_ - `PHP `_ - :api:`Python ` -- `Ruby `_ +- :ruby:`Ruby ` - `Scala `_ - `Swift `_ diff --git a/source/core/retryable-reads.txt b/source/core/retryable-reads.txt index 3e509d2c348..855d9f7bb48 100644 --- a/source/core/retryable-reads.txt +++ b/source/core/retryable-reads.txt @@ -24,7 +24,7 @@ Minimum Driver Version support retryable reads. For more information on official MongoDB drivers, see - `MongoDB Drivers `__. + :driver:`MongoDB Drivers `. Minimum Server Version Drivers can only retry read operations if connected to @@ -89,7 +89,7 @@ syntax and usage, defer to the driver documentation for that method. MongoDB drivers *may* include retryable support for other operations, such as helper methods or methods that wrap a retryable read operation. -Defer to the `driver documentation `__ +Defer to the :driver:`driver documentation ` to determine whether a method explicitly supports retryable reads. .. seealso:: diff --git a/source/core/security-client-side-encryption.txt b/source/core/security-client-side-encryption.txt index 59386bb8aba..02a4aaf997d 100644 --- a/source/core/security-client-side-encryption.txt +++ b/source/core/security-client-side-encryption.txt @@ -468,11 +468,11 @@ the following official 4.2+ compatible driver versions: * - :driver:`PHP ` - ``1.6.0+`` - - `PHP Driver Quickstart `__ + - `PHP Driver Quickstart `__ - * - `Ruby `__ + * - :ruby:`Ruby ` - ``2.12.1+`` - - `Ruby Driver Quickstart `__ + - :ruby:`Ruby Driver Quickstart ` Please refer to the driver reference documentation for syntax and implementation examples. diff --git a/source/includes/driver-examples/driver-example-indexes-1.rst b/source/includes/driver-examples/driver-example-indexes-1.rst index c9c517e4b1c..c084bd03bb7 100644 --- a/source/includes/driver-examples/driver-example-indexes-1.rst +++ b/source/includes/driver-examples/driver-example-indexes-1.rst @@ -134,7 +134,7 @@ - id: nodejs content: | To create an index using the - `Node.JS driver `_, + `Node.JS driver `_, use ``createIndex()``. .. code-block:: javascript @@ -161,7 +161,7 @@ - id: php content: | To create an index using the - `PHP driver `_, use + `PHP driver `_, use :phpmethod:`MongoDB\\Collection::createIndex() `. diff --git a/source/includes/driver-examples/driver-example-insert-2.rst b/source/includes/driver-examples/driver-example-insert-2.rst index 9de20737ffd..a69a5ddb0dc 100644 --- a/source/includes/driver-examples/driver-example-insert-2.rst +++ b/source/includes/driver-examples/driver-example-insert-2.rst @@ -21,7 +21,7 @@ For more information on the MongoDB Compass Query Bar, see the Compass - `Query Bar `_ + :compass:`Query Bar ` documentation. - id: python diff --git a/source/includes/driver-examples/driver-example-query-intro.rst b/source/includes/driver-examples/driver-example-query-intro.rst index b7653e32547..2799b708d4c 100644 --- a/source/includes/driver-examples/driver-example-query-intro.rst +++ b/source/includes/driver-examples/driver-example-query-intro.rst @@ -74,7 +74,7 @@ This page provides examples of |query_operations| using the :phpmethod:`MongoDB\\Collection::find() ` method in the - `MongoDB PHP Library `_. + `MongoDB PHP Library `_. The examples on this page use the ``inventory`` collection. To populate the ``inventory`` collection, run the following: @@ -92,7 +92,7 @@ This page provides examples of |query_operations| using the :ruby-api:`Mongo::Collection#find()` method in the - `MongoDB Ruby Driver `_. + :ruby:`MongoDB Ruby Driver `. The examples on this page use the ``inventory`` collection. To populate the ``inventory`` collection, run the following: diff --git a/source/includes/fact-uuid-restore-from-backup.rst b/source/includes/fact-uuid-restore-from-backup.rst index 0b39c026d86..2ef8e34d55b 100644 --- a/source/includes/fact-uuid-restore-from-backup.rst +++ b/source/includes/fact-uuid-restore-from-backup.rst @@ -9,4 +9,4 @@ present, MongoDB generates a UUID for the restored collection. For more information on collection UUIDs, see - `Collections `_. \ No newline at end of file + `Collections `_. diff --git a/source/includes/list-4.2-drivers.rst b/source/includes/list-4.2-drivers.rst index be41f5736ae..768701c2ce3 100644 --- a/source/includes/list-4.2-drivers.rst +++ b/source/includes/list-4.2-drivers.rst @@ -17,7 +17,7 @@ - :api:`Python 3.9.0 ` - - `Ruby 2.10.0 `__ + - :ruby:`Ruby 2.10.0 ` - `Scala 2.7.0 `__ diff --git a/source/includes/list-table-products-supported-architecture.rst b/source/includes/list-table-products-supported-architecture.rst index ea2a3407324..551b2593e1f 100644 --- a/source/includes/list-table-products-supported-architecture.rst +++ b/source/includes/list-table-products-supported-architecture.rst @@ -18,25 +18,25 @@ version of MongoDB products: - |checkmark| - * - `BI Connector `__ + * - :bic:`BI Connector ` - |checkmark| - |checkmark| - |checkmark| - - * - `Compass `__ + * - :compass:`Compass ` - |checkmark| - - - - * - `Spark Connector `__ + * - `Spark Connector `__ - |checkmark| - - - - * - `Ops Manager `__ + * - :opsmgr:`Ops Manager ` - |checkmark| - - diff --git a/source/includes/upgrade-guidance-checklists.rst b/source/includes/upgrade-guidance-checklists.rst index d016b98cf69..2c4a58aee21 100644 --- a/source/includes/upgrade-guidance-checklists.rst +++ b/source/includes/upgrade-guidance-checklists.rst @@ -24,8 +24,8 @@ Check Driver Compatibility ~~~~~~~~~~~~~~~~~~~~~~~~~~ Before you upgrade MongoDB, check that you're using a MongoDB -|newversion|-compatible driver. Consult the `driver documentation -`_ for your specific driver to verify +|newversion|-compatible driver. Consult the :driver:`driver documentation +` for your specific driver to verify compatibility with MongoDB |newversion|. Upgraded deployments that run on incompatible drivers might encounter diff --git a/source/index.txt b/source/index.txt index 1d7b267f2c2..c2c6082711b 100644 --- a/source/index.txt +++ b/source/index.txt @@ -55,7 +55,7 @@ Work with your data in MongoDB Import data from CSV or JSON files into your MongoDB database. - `To learn more, see MongoDB Shell (mongosh) `__ + :mongosh:`To learn more, see MongoDB Shell (mongosh) ` .. step:: Insert, query, update, or delete documents @@ -70,7 +70,7 @@ Work with your data in MongoDB Current Mongosh Log ID: 123a4bc5d67891011ef1213g Connecting to: mongodb://127.0.0.1:27017/ - For mongosh info see: https://docs.mongodb.com/mongodb-shell/ + For mongosh info see: https://www.mongodb.com/docs/mongodb-shell/ test> db.messages.insertMany([ { @@ -94,7 +94,7 @@ Work with your data in MongoDB Import data from a CSV or JSON file with mongoimport. - `To learn more, see mongoimport `__ + `To learn more, see mongoimport `__ .. step:: Aggregate your data @@ -190,7 +190,7 @@ Explore libraries and tools for MongoDB. .. card:: :cta: Learn about Drivers - :url: https://docs.mongodb.com/drivers/ + :url: https://www.mongodb.com/docs/drivers/ :icon: /images/icons/drivers.svg :icon-alt: MongoDB Atlas icon @@ -198,7 +198,7 @@ Explore libraries and tools for MongoDB. .. card:: :cta: View Compass Docs - :url: https://docs.mongodb.com/compass/current/ + :url: https://www.mongodb.com/docs/compass/current/ :icon: /images/icons/compass.svg :icon-alt: MongoDB University icon @@ -206,7 +206,7 @@ Explore libraries and tools for MongoDB. .. card:: :cta: View Ops Manager - :url: https://docs.opsmanager.mongodb.com/current/ + :url: https://www.mongodb.com/docs/ops-manager/current/ :icon: /images/icons/opsmanager.svg :icon-alt: MongoDB Server icon @@ -217,7 +217,7 @@ Explore libraries and tools for MongoDB. Introduction Installation - MongoDB Shell (mongosh) + MongoDB Shell (mongosh) /crud /aggregation /data-modeling diff --git a/source/query-api.txt b/source/query-api.txt index 28ca41fbed8..4c7b2cd5eeb 100644 --- a/source/query-api.txt +++ b/source/query-api.txt @@ -23,7 +23,7 @@ The |query-api| comprises two ways to query data in MongoDB: You can use the |query-api| to perform: - **Adhoc queries**. Explore your MongoDB data with :binary:`~bin.mongosh`, - `Compass `_ , + :compass:`Compass ` , `VSCode `_ or a MongoDB :driver:`driver `. @@ -84,4 +84,4 @@ Getting Started To get started, visit the MongoDB :doc:`Getting Started Guide `. Here you can find resources, code examples and tutorials that demonstrate the MongoDB -|query-api|. \ No newline at end of file +|query-api|. diff --git a/source/reference/configuration-file-settings-command-line-options-mapping.txt b/source/reference/configuration-file-settings-command-line-options-mapping.txt index 3b77a079d40..9c40ac9be51 100644 --- a/source/reference/configuration-file-settings-command-line-options-mapping.txt +++ b/source/reference/configuration-file-settings-command-line-options-mapping.txt @@ -514,6 +514,6 @@ Starting in version 4.2: For earlier versions of MongoDB, refer to the corresponding version of the manual. For example: - - :v4.0:`https://docs.mongodb.com/v4.0 ` - - :v3.6:`https://docs.mongodb.com/v3.6 ` - - :v3.4:`https://docs.mongodb.com/v3.4 ` + - :v4.0:`https://www.mongodb.com/docs/v4.0 ` + - :v3.6:`https://www.mongodb.com/docs/v3.6 ` + - :v3.4:`https://www.mongodb.com/docs/v3.4 ` diff --git a/source/reference/configuration-options.txt b/source/reference/configuration-options.txt index 9d11c80c9b2..1658d21227e 100644 --- a/source/reference/configuration-options.txt +++ b/source/reference/configuration-options.txt @@ -4857,9 +4857,9 @@ engine and the MMAPv1-specific configuration options: For earlier versions of MongoDB, refer to the corresponding version of the manual. For example: -- :v4.0:`https://docs.mongodb.com/v4.0 ` -- :v3.6:`https://docs.mongodb.com/v3.6 ` -- :v3.4:`https://docs.mongodb.com/v3.4 ` +- :v4.0:`https://www.mongodb.com/docs/v4.0 ` +- :v3.6:`https://www.mongodb.com/docs/v3.6 ` +- :v3.4:`https://www.mongodb.com/docs/v3.4 ` .. toctree:: :hidden: diff --git a/source/reference/database-references.txt b/source/reference/database-references.txt index 2b7b294047b..a9413f5ca25 100644 --- a/source/reference/database-references.txt +++ b/source/reference/database-references.txt @@ -263,7 +263,7 @@ Driver Support for DBRefs - Supported - - Please see the `Ruby driver page `__ + - Please see the :ruby:`Ruby driver page ` for more information. * - Scala diff --git a/source/reference/log-messages.txt b/source/reference/log-messages.txt index ad74a6de0d6..e2b80468aed 100644 --- a/source/reference/log-messages.txt +++ b/source/reference/log-messages.txt @@ -757,7 +757,7 @@ examples that filter on the component field. Client Data ~~~~~~~~~~~ -`MongoDB drivers `_ and +:driver:`MongoDB drivers and client applications (including :binary:`~bin.mongosh`) have the ability to send identifying information at the time of connection to the server. After the connection is established, the client does not send @@ -1083,8 +1083,7 @@ change: Analyzing Driver Connections ```````````````````````````` -The following example counts all remote `MongoDB driver -`__ connections, and +The following example counts all remote :driver:`MongoDB driver` connections, and presents each driver type and version in descending order by number of occurrences: @@ -1096,8 +1095,7 @@ Analyzing Client Types `````````````````````` The following example analyzes the reported :ref:`client data -` of remote `MongoDB driver -`__ +` of remote :driver:`MongoDB driver ` connections and client applications, including :binary:`~bin.mongosh`, and prints a total for each unique operating system type that connected, sorted by frequency: diff --git a/source/reference/mongodb-defaults.txt b/source/reference/mongodb-defaults.txt index 699a6501125..f7ab6b4530a 100644 --- a/source/reference/mongodb-defaults.txt +++ b/source/reference/mongodb-defaults.txt @@ -83,10 +83,9 @@ Specify Read Concern: MongoDB Drivers inside transactions, click on the ``Operations in Transactions`` tab. - Using the `MongoDB drivers `__, - you can override the default :doc:`read concern - ` and set read concern for operations at - the following levels: + Using the :driver:`MongoDB drivers `, you can override the default + :doc:`read concern ` and set read concern for operations + at the following levels: .. list-table:: :header-rows: 1 @@ -128,8 +127,7 @@ Specify Read Concern: MongoDB Drivers database/client/collection read concern). The ability to set read concern at the operation depends on the - driver. Refer to your `driver's documentation - `__. + driver. Refer to your :driver:`driver's documentation `. .. note:: @@ -147,8 +145,7 @@ Specify Read Concern: MongoDB Drivers :red:`outside` transactions, click on the ``Operations outside Transactions`` tab. - Using the `MongoDB drivers `__, - you can override the default :doc:`read concern + Using the :driver:`MongoDB drivers `,you can override the default :doc:`read concern ` and set read concern **for transactions** at the following levels: @@ -243,10 +240,9 @@ Specify Write Concern: MongoDB Drivers inside transactions, click on the ``Operations in Transactions`` tab. - Using the `MongoDB drivers `__, - you can override the default :doc:`write concern - ` and set write concern for operations at - the following levels: + Using the :driver:`MongoDB drivers `, you can override the default + :doc:`write concern ` and set write concern for + operations at the following levels: .. list-table:: :header-rows: 1 @@ -287,8 +283,7 @@ Specify Write Concern: MongoDB Drivers - Applies to the specific write operation. The ability to set write concern at the operation depends on the - driver. Refer to your `driver's documentation - `__. + driver. Refer to your :driver:`driver's documentation `. .. note:: @@ -306,8 +301,7 @@ Specify Write Concern: MongoDB Drivers :red:`outside` transactions, click on the ``Operations outside Transactions`` tab. - Using the `MongoDB drivers `__, - you can override the default :doc:`write concern + Using the :driver:`MongoDB drivers `, you can override the default :doc:`write concern ` and set write concern for **for transactions** at the following levels: diff --git a/source/reference/program.txt b/source/reference/program.txt index c1045c89c70..0e8688fd59c 100644 --- a/source/reference/program.txt +++ b/source/reference/program.txt @@ -89,8 +89,8 @@ MongoDB Database Tools ---------------------- Starting in MongoDB 4.4, the documentation for these -tools have been migrated to `docs.mongodb.com/database-tools -`__: +tools have been migrated to :dbtools:`mongodb.com/docs/database-tools +`: For documentation on previous versions of these tools, use the version selector in the top-left corner of the web page to @@ -105,4 +105,4 @@ view the documentation for your desired MongoDB version. :maxdepth: 1 :hidden: - MongoDB Database Tools + MongoDB Database Tools diff --git a/source/reference/program/mongo.txt b/source/reference/program/mongo.txt index c5a5ed4626f..fa727840c9a 100644 --- a/source/reference/program/mongo.txt +++ b/source/reference/program/mongo.txt @@ -168,7 +168,7 @@ Core Options For TLS/SSL connections (``--ssl``), .. include:: /includes/extracts/ssl-facts-mongo-ssl-hostname-verification.rst - For `DNS seedlist connections `_, + For :ref:`DNS Seed List connections `, Specify the connection protocol as ``mongodb+srv``, followed by the DNS SRV hostname record and any options. The ``authSource`` and ``replicaSet`` options, if included in the connection string, diff --git a/source/reference/versioning.txt b/source/reference/versioning.txt index cc5b298419d..4e9285a58cd 100644 --- a/source/reference/versioning.txt +++ b/source/reference/versioning.txt @@ -93,16 +93,15 @@ used for the :ecosystem:`MongoDB drivers `. MongoDB Shell (``mongosh``) --------------------------- -Starting with MongoDB 5.0, the `MongoDB Shell -`__ (``mongosh``) is released -separately from the MongoDB Server, and uses its own version numbering -system. +Starting with MongoDB 5.0, the :mongosh:`MongoDB Shell +` (``mongosh``) is released separately from the MongoDB Server, and uses its +own version numbering system. Database Tools -------------- -Starting with MongoDB 4.4, the `MongoDB Database Tools -`__ are released separately +Starting with MongoDB 4.4, the :dbtools:`MongoDB Database Tools +` are released separately from the MongoDB Server, and use their own version numbering system. .. _historical-releases: diff --git a/source/release-notes/4.2-downgrade-replica-set.txt b/source/release-notes/4.2-downgrade-replica-set.txt index 517ad176b54..05723ea1333 100644 --- a/source/release-notes/4.2-downgrade-replica-set.txt +++ b/source/release-notes/4.2-downgrade-replica-set.txt @@ -361,8 +361,8 @@ for each collection using the 4.0-incompatible keywords: - Use :dbcommand:`collMod` to modify the collection's :collflag:`validator` and replace the :query:`$jsonSchema` with a schema that contains only - `4.0-compatible document validation syntax - `__: + :v4.0:`4.0-compatible document validation syntax + `: .. code-block:: javascript diff --git a/source/release-notes/4.2-downgrade-sharded-cluster.txt b/source/release-notes/4.2-downgrade-sharded-cluster.txt index 1cc38f86112..a48dce57c0f 100644 --- a/source/release-notes/4.2-downgrade-sharded-cluster.txt +++ b/source/release-notes/4.2-downgrade-sharded-cluster.txt @@ -388,8 +388,8 @@ operations for each collection using the 4.0-incompatible keywords: - Use :dbcommand:`collMod` to modify the collection's :collflag:`validator` and replace the :query:`$jsonSchema` with a schema that contains only - `4.0-compatible document validation syntax - `__: + :v4.0:`4.0-compatible document validation syntax + `: .. code-block:: javascript diff --git a/source/release-notes/4.2-downgrade-standalone.txt b/source/release-notes/4.2-downgrade-standalone.txt index c4030ffccb9..25c86593349 100644 --- a/source/release-notes/4.2-downgrade-standalone.txt +++ b/source/release-notes/4.2-downgrade-standalone.txt @@ -223,8 +223,8 @@ collection using the 4.0-incompatible keywords: - Use :dbcommand:`collMod` to modify the collection's :collflag:`validator` and replace the :query:`$jsonSchema` with a schema that contains only - `4.0-compatible document validation syntax - `__: + :v4.0:`4.0-compatible document validation syntax + `: .. code-block:: javascript diff --git a/source/release-notes/4.4.txt b/source/release-notes/4.4.txt index eccfcaadf81..c152e232e5b 100644 --- a/source/release-notes/4.4.txt +++ b/source/release-notes/4.4.txt @@ -1579,8 +1579,7 @@ Migration to MongoDB Database Tools Project ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Starting in MongoDB 4.4, the documentation for the following -tools have been migrated to the `MongoDB Database Tools project -`__: +tools have been migrated to the :dbtools:`MongoDB Database Tools project `: - :binary:`~bin.mongoimport` - :binary:`~bin.mongoexport` @@ -1646,11 +1645,9 @@ Drivers New Drivers ~~~~~~~~~~~ -- The official `MongoDB Rust driver - `__ is now available. +- The official :driver:`MongoDB Rust driver ` is now available. -- The official `MongoDB Swift driver - `__ is now available. +- The official :driver:`MongoDB Swift driver ` is now available. .. _4.4-removed-commands: diff --git a/source/tutorial/analyze-query-plan.txt b/source/tutorial/analyze-query-plan.txt index 85a594383ea..4798d7e14b2 100644 --- a/source/tutorial/analyze-query-plan.txt +++ b/source/tutorial/analyze-query-plan.txt @@ -28,11 +28,9 @@ subject to change between MongoDB versions. - id: compass content: | - |compass| provides an - `Explain Plan `_ - tab, which displays statistics about the performance of a - query. These statistics can be useful in measuring if and how - a query uses an index. + |compass| provides an :compass:`Explain Plan ` tab, which + displays statistics about the performance of a query. These statistics + can be useful in measuring if and how a query uses an index. Evaluate the Performance of a Query ----------------------------------- @@ -586,4 +584,4 @@ in a very efficient query. - :doc:`Query Optimization ` - :ref:`MongoDB Compass Documentation ` - - `Compass Query Plan Documentation `_ + - :compass:`Compass Query Plan Documentation ` diff --git a/source/tutorial/authenticate-a-user.txt b/source/tutorial/authenticate-a-user.txt index e613ac4e47d..6f3d78de0ab 100644 --- a/source/tutorial/authenticate-a-user.txt +++ b/source/tutorial/authenticate-a-user.txt @@ -73,5 +73,4 @@ Using :binary:`~bin.mongosh`, you can: Enter the password when prompted. -For examples using a MongoDB driver, see the -`driver documentation `__. +For examples using a MongoDB driver, see the :driver:`driver documentation `. diff --git a/source/tutorial/backup-sharded-cluster-with-database-dumps.txt b/source/tutorial/backup-sharded-cluster-with-database-dumps.txt index f0a4ae64607..f9b73b3c7c5 100644 --- a/source/tutorial/backup-sharded-cluster-with-database-dumps.txt +++ b/source/tutorial/backup-sharded-cluster-with-database-dumps.txt @@ -16,6 +16,6 @@ Back Up a Sharded Cluster with Database Dumps For MongoDB 4.0 and earlier deployments, refer to the corresponding versions of the manual. For example: - - :v4.0:`https://docs.mongodb.com/v4.0 ` - - :v3.6:`https://docs.mongodb.com/v3.6 ` - - :v3.4:`https://docs.mongodb.com/v3.4 ` + - :v4.0:`https://www.mongodb.com/docs/v4.0 ` + - :v3.6:`https://www.mongodb.com/docs/v3.6 ` + - :v3.4:`https://www.mongodb.com/docs/v3.4 ` diff --git a/source/tutorial/configure-ssl-clients.txt b/source/tutorial/configure-ssl-clients.txt index afa3bbd1a1c..5b658cb54ee 100644 --- a/source/tutorial/configure-ssl-clients.txt +++ b/source/tutorial/configure-ssl-clients.txt @@ -416,7 +416,7 @@ The MongoDB Drivers support encrypted communication. See: - `Perl Driver `_ - `PHP Driver `_ - `Python Driver `_ -- `Ruby Driver `_ +- `Ruby Driver `_ - `Scala Driver `_ .. _mongodb-tools-support-ssl: diff --git a/source/tutorial/install-mongodb-on-os-x.txt b/source/tutorial/install-mongodb-on-os-x.txt index be9b162c054..8131490a4a8 100644 --- a/source/tutorial/install-mongodb-on-os-x.txt +++ b/source/tutorial/install-mongodb-on-os-x.txt @@ -28,8 +28,7 @@ macOS using the third-party `Homebrew `__ package manager. Starting with MongoDB 4.4.1, installing MongoDB via Homebrew also -installs the `MongoDB Database Tools -`__. See +installs the :dbtools:`MongoDB Database Tools `. See :ref:`brew-installs-dbtools` for more information. MongoDB Version @@ -172,7 +171,7 @@ these files and directories: brew --prefix Starting with MongoDB 4.4.1, the installation also includes the -`MongoDB Database Tools `__. +:dbtools:`MongoDB Database Tools `. See :ref:`brew-installs-dbtools` for more information. .. _run-with-homebrew: @@ -275,8 +274,7 @@ Using the MongoDB Database Tools Starting in MongoDB 4.4.1, installing MongoDB via ``brew`` also installs the MongoDB Database Tools. -The `MongoDB Database Tools -`__ are a collection of +The :dbtools:`MongoDB Database Tools ` are a collection of command-line utilities for working with a MongoDB deployment, including data backup and import/export tools like :binary:`mongoimport` and :binary:`mongodump` as well as monitoring @@ -295,8 +293,7 @@ macOS Terminal like so: It should start up, connect to your running :binary:`mongod`, and start reporting usage statistics. -See the `MongoDB Database Tools Documentation -`__ for usage information for +See the :dbtools:`MongoDB Database Tools Documentation` for usage information for each of the Database Tools. Additional Information diff --git a/source/tutorial/manage-client-side-encryption-data-keys.txt b/source/tutorial/manage-client-side-encryption-data-keys.txt index 201c583ecbe..639a8b752f7 100644 --- a/source/tutorial/manage-client-side-encryption-data-keys.txt +++ b/source/tutorial/manage-client-side-encryption-data-keys.txt @@ -33,8 +33,7 @@ Create a Data Encryption Key The following procedure uses :binary:`~bin.mongosh` to create a data encryption key for use with client-side field level encryption and decryption. For guidance on data encryption key management using a -4.2+ compatible driver, see the `driver documentation -`__ instead. +4.2+ compatible driver, see the :driver:`driver documentation ` instead. Use the tabs below to select the :abbr:`KMS (Key Management Service)` appropriate for your deployment: @@ -69,7 +68,7 @@ Manage a Data Encryption Key's Alternate Name The following procedure uses :binary:`~bin.mongosh` to manage the alternate names of a data encryption key. For guidance on data encryption key management using a 4.2+ compatible driver, see the -`driver documentation `__ instead. +:driver:`driver documentation ` instead. If you are still within your configured :binary:`~bin.mongosh` session from the :ref:`field-level-encryption-data-key-create` steps above, you @@ -113,7 +112,7 @@ Remove a Data Encryption Key The following procedure uses :binary:`~bin.mongosh` to remove a data encryption key from the key vault. For guidance on data encryption key management using a 4.2+ compatible driver, see the -`driver documentation `__ instead. +:driver:`driver documentation ` instead. If you are still within your configured :binary:`~bin.mongosh` session from the :ref:`field-level-encryption-data-key-create` steps above, you diff --git a/source/tutorial/manage-indexes.txt b/source/tutorial/manage-indexes.txt index cc94dfe38ed..ea1a13a345c 100644 --- a/source/tutorial/manage-indexes.txt +++ b/source/tutorial/manage-indexes.txt @@ -50,7 +50,7 @@ Modify an Index .. seealso:: - :ref:`MongoDB Compass Documentation ` - - `Compass Documentation for Indexes `_ + - :compass:`Compass Documentation for Indexes ` .. _manage-indexes-find-inconsistent-indexes: diff --git a/source/tutorial/query-documents.txt b/source/tutorial/query-documents.txt index 68ad68bd920..09241d2d299 100644 --- a/source/tutorial/query-documents.txt +++ b/source/tutorial/query-documents.txt @@ -384,19 +384,19 @@ level of isolation for their reads. For more information, see .. list-table:: :widths: 25 75 - * - `Project `_ + * - :compass:`Project ` - Specify which fields to return in the resulting data. - * - `Sort `_ + * - :compass:`Sort ` - Specify the sort order of the returned documents. - * - `Skip `_ + * - :compass:`Skip ` - Specify the first n-number of document to skip before returning the result set. - * - `Limit `_ + * - :compass:`Limit ` - Specify the maximum number of documents to return. @@ -532,7 +532,7 @@ level of isolation for their reads. For more information, see - In :doc:`aggregation pipeline `, the :pipeline:`$match` pipeline stage provides access to MongoDB queries. See the MongoDB Ruby driver's - `aggregation examples `__. + :ruby:`aggregation examples `. - id: scala content: | diff --git a/source/tutorial/remove-documents.txt b/source/tutorial/remove-documents.txt index 8f9951abf08..117fc72c695 100644 --- a/source/tutorial/remove-documents.txt +++ b/source/tutorial/remove-documents.txt @@ -111,7 +111,7 @@ upper-right to set the language of the following examples. - id: php content: | This page uses the - following `MongoDB PHP Library `_ methods: + following `MongoDB PHP Library `_ methods: - :phpmethod:`MongoDB\\Collection::deleteMany() ` - :phpmethod:`MongoDB\\Collection::deleteOne() ` @@ -132,7 +132,7 @@ upper-right to set the language of the following examples. - id: ruby content: | This page uses the - following `MongoDB Ruby Driver `_ methods: + following :ruby:`MongoDB Ruby Driver ` methods: - :ruby-api:`Mongo::Collection#delete_many()` - :ruby-api:`Mongo::Collection#delete_one()` @@ -153,7 +153,7 @@ upper-right to set the language of the following examples. - id: csharp content: | This page uses the - following `MongoDB C# Driver `_ methods: + following :driver:`MongoDB C# Driver ` methods: - :csharp-api:`IMongoCollection.DeleteMany() ` - :csharp-api:`IMongoCollection.DeleteOne() ` @@ -163,7 +163,7 @@ upper-right to set the language of the following examples. - id: go content: | This page uses the - following `MongoDB Go Driver `_ functions: + following :driver:`MongoDB Go Driver ` functions: - :go-api:`Collection.DeleteMany` @@ -702,7 +702,7 @@ requested from MongoDB for write operations. For details, see content: | .. seealso:: - - `Compass Documents `_ + - :compass:`Compass Documents ` - :ref:`Compass Query Bar ` diff --git a/source/tutorial/restore-sharded-cluster.txt b/source/tutorial/restore-sharded-cluster.txt index d47bd6ccb31..755cc3f4d04 100644 --- a/source/tutorial/restore-sharded-cluster.txt +++ b/source/tutorial/restore-sharded-cluster.txt @@ -25,9 +25,9 @@ sharded cluster, see :ref:`backup-sharded-lvm`. For MongoDB 4.0 and earlier deployments, refer to the corresponding versions of the manual. For example: - - :v4.0:`https://docs.mongodb.com/v4.0 ` - - :v3.6:`https://docs.mongodb.com/v3.6 ` - - :v3.4:`https://docs.mongodb.com/v3.4 ` + - :v4.0:`https://www.mongodb.com/docs/v4.0 ` + - :v3.6:`https://www.mongodb.com/docs/v3.6 ` + - :v3.4:`https://www.mongodb.com/docs/v3.4 ` Considerations -------------- diff --git a/source/tutorial/update-documents.txt b/source/tutorial/update-documents.txt index d2e904235fb..8126dc4a499 100644 --- a/source/tutorial/update-documents.txt +++ b/source/tutorial/update-documents.txt @@ -138,7 +138,7 @@ upper-right to set the language of the following examples. :tabid: php This page uses the following `MongoDB PHP Library - `_ methods: + `_ methods: - :phpmethod:`MongoDB\\Collection::updateOne() ` @@ -165,8 +165,7 @@ upper-right to set the language of the following examples. .. tab:: :tabid: ruby - This page uses the following `MongoDB Ruby Driver - `_ methods: + This page uses the following :ruby:`MongoDB Ruby Driver ` methods: - :ruby-api:`Mongo::Collection#update_one()` @@ -193,8 +192,7 @@ upper-right to set the language of the following examples. .. tab:: :tabid: csharp - This page uses the following `MongoDB C# Driver - `_ methods: + This page uses the following :driver:`MongoDB C# Driver ` methods: - :csharp-api:`IMongoCollection.UpdateOne()` @@ -207,8 +205,7 @@ upper-right to set the language of the following examples. .. tab:: :tabid: go - This page uses the following `MongoDB Go Driver - `_ functions: + This page uses the following :driver:`MongoDB Go Driver ` functions: - :go-api:`Collection.UpdateOne` @@ -1194,7 +1191,7 @@ requested from MongoDB for write operations. For details, see .. seealso:: - - `Compass Documents `_ + - :compass:`Compass Documents ` - :ref:`Compass Query Bar `