Skip to content

Commit

Permalink
PR for DOCSP-20352 Subdomain consolidation (#1032)
Browse files Browse the repository at this point in the history
* 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 <[email protected]>

* Update source/includes/list-table-products-supported-architecture.rst

Co-authored-by: jeff-allen-mongo <[email protected]>

* Update source/includes/list-table-products-supported-architecture.rst

Co-authored-by: jeff-allen-mongo <[email protected]>

* Update source/includes/list-table-products-supported-architecture.rst

Co-authored-by: jeff-allen-mongo <[email protected]>

* Update source/reference/program.txt

Co-authored-by: jeff-allen-mongo <[email protected]>

* Update source/tutorial/analyze-query-plan.txt

Co-authored-by: jeff-allen-mongo <[email protected]>

* Update source/tutorial/manage-client-side-encryption-data-keys.txt

Co-authored-by: jeff-allen-mongo <[email protected]>

* 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 <[email protected]>

* DOCSP-20352: Review feedback

* DOCSP-20352: Fix two minor errors

Co-authored-by: Sarah Olson <[email protected]>
Co-authored-by: jeff-allen-mongo <[email protected]>
Co-authored-by: Allison Reinheimer Moore <[email protected]>
  • Loading branch information
4 people authored May 4, 2022
1 parent 7f21687 commit 0a02db5
Show file tree
Hide file tree
Showing 46 changed files with 139 additions and 191 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<http://docs.mongodb.org/manual/meta/translation/>`_.
<https://www.mongodb.com/docs/meta/translation/>`_.

MongoDB documentation is distributed under a `Creative Commons
Attribution-NonCommercial-ShareAlike 3.0 Unported`_ license. MongoDB,
Expand All @@ -19,10 +19,10 @@ pull request.
Please review the following documents for our style, conventions,
processes and practices for the MongoDB Documentation:

- `Style Guide <http://docs.mongodb.org/meta/style-guide>`_
- `Documentation Practices <http://docs.mongodb.org/meta/practices>`_
- `Documentation Organization <http://docs.mongodb.org/meta/organization>`_
- `Documentation Build Tools <https://docs.mongodb.com/meta/tutorials/install/>`_
- `Style Guide <https://www.mongodb.com/docs/meta/style-guide>`_
- `Documentation Practices <https://www.mongodb.com/docs/meta/practices>`_
- `Documentation Organization <https://www.mongodb.com/docs/meta/organization>`_
- `Documentation Build Tools <https://www.mongodb.com/docs/meta/tutorials/install/>`_

Do not hesitate to open a ticket in our `Jira`_ project
or to contact the `documentation team`_
Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://pypi.python.org/pypi/giza>`_ installed: ::

Expand Down
30 changes: 0 additions & 30 deletions conf-sitemap.xml

This file was deleted.

2 changes: 1 addition & 1 deletion config/build_conf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
26 changes: 13 additions & 13 deletions config/redirects
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand All @@ -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/
Expand Down
10 changes: 5 additions & 5 deletions snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions source/.static/osd.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
<Description>Google Custom Search of MongoDB documentation (docs.mongodb.com)</Description>
<Tags>mongodb mongo mongodocs</Tags>
<Query role="example" searchTerms="mongodb"/>
<Image height="32" width="32" type="image/vnd.microsoft.icon">https://docs.mongodb.com/favicon.ico</Image>
<Image height="32" width="32" type="image/vnd.microsoft.icon">https://www.mongodb.com/docs/favicon.ico</Image>
<Developer>MongoDB, Inc.</Developer>
<Contact>[email protected]</Contact>
<Url type="text/html" rel="results" template="https://docs.mongodb.com/manual/?query={searchTerms}" />
<Url type="application/opensearchdescription+xml" rel="self" template="https://docs.mongodb.com/osd.xml"/>
<Url type="text/html" rel="results" template="https://www.mongodb.com/docs/search/?query={searchTerms}" />
<Url type="application/opensearchdescription+xml" rel="self" template="https://www.mongodb.com/docs/osd.xml"/>
</OpenSearchDescription>
10 changes: 5 additions & 5 deletions source/about.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ About MongoDB Documentation
:depth: 1
:class: singlecol

`The MongoDB Manual <https://docs.mongodb.com/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.
Expand All @@ -29,7 +29,7 @@ Attribution-NonCommercial-ShareAlike 3.0 United States License
Man Pages
---------

In addition to the `MongoDB Manual <https://docs.mongodb.com/manual/#>`_, you can
In addition to the :manual:`MongoDB Manual </#>`, you can
access the :manual:`MongoDB Man Pages </manpages.tar.gz>`,
which are also distributed with the official MongoDB Packages.

Expand All @@ -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 <https://docs.mongodb.com>`_
See the `MongoDB Documentation Project Page <https://www.mongodb.com/docs>`_
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 <https://github.com/mongodb/docs>`_.

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
----------------------------------------
Expand Down Expand Up @@ -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 <https://docs.mongodb.com/meta/>`__.
`Meta Documentation <https://www.mongodb.com/docs/meta/>`__.

If you have any questions, please feel free to open a :issue:`Jira Case
<DOCS>`.
Expand Down
2 changes: 1 addition & 1 deletion source/administration/production-notes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://docs.mongodb.com/?tck=docs_server>`_.
page or their `respective documentation <https://www.mongodb.com/docs/?tck=docs_server>`_.

MongoDB ``dbPath``
------------------
Expand Down
4 changes: 2 additions & 2 deletions source/changeStreams.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://docs.mongodb.com/php-library/current/reference/method/MongoDBClient__construct/>`__
<https://www.mongodb.com/docs/php-library/current/reference/method/MongoDBClient__construct/>`__
that contains an ``inventory`` collection.

.. literalinclude:: /driver-examples/DocumentationExamplesTest.php
Expand All @@ -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
<https://docs.mongodb.com/ruby-driver/master/tutorials/ruby-driver-create-client/>`__
<https://www.mongodb.com/docs/ruby-driver/master/tutorials/ruby-driver-create-client/>`__
that contains an ``inventory`` collection.


Expand Down
2 changes: 1 addition & 1 deletion source/contents.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ project, this Manual and additional editions of this text.

Introduction </introduction>
Installation </installation>
MongoDB Shell (mongosh) <https://docs.mongodb.com/mongodb-shell/>
MongoDB Shell (mongosh) <https://www.mongodb.com/docs/mongodb-shell/>
/crud
/aggregation
/data-modeling
Expand Down
2 changes: 1 addition & 1 deletion source/core/kerberos.txt
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ The following MongoDB drivers support Kerberos authentication:
- `Perl <https://metacpan.org/pod/MongoDB::MongoClient#GSSAPI-(for-Kerberos)>`_
- `PHP <http://php.net/manual/en/mongodb-driver-manager.construct.php>`_
- :api:`Python <pymongo>`
- `Ruby <https://docs.mongodb.com/ruby-driver/current/tutorials/ruby-driver-authentication/#kerberos-gssapi-mechanism>`_
- :ruby:`Ruby </tutorials/ruby-driver-authentication/#kerberos-gssapi-mechanism>`
- `Scala <http://mongodb.github.io/mongo-scala-driver/2.1/reference/connecting/authenticating/>`_
- `Swift <https://mongodb.github.io/mongo-swift-driver/docs/current/>`_

Expand Down
4 changes: 2 additions & 2 deletions source/core/retryable-reads.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Minimum Driver Version
support retryable reads.

For more information on official MongoDB drivers, see
`MongoDB Drivers <https://docs.mongodb.com/drivers/>`__.
:driver:`MongoDB Drivers </>`.

Minimum Server Version
Drivers can only retry read operations if connected to
Expand Down Expand Up @@ -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 <https://docs.mongodb.com/drivers/>`__
Defer to the :driver:`driver documentation </>`
to determine whether a method explicitly supports retryable reads.

.. seealso::
Expand Down
6 changes: 3 additions & 3 deletions source/core/security-client-side-encryption.txt
Original file line number Diff line number Diff line change
Expand Up @@ -468,11 +468,11 @@ the following official 4.2+ compatible driver versions:

* - :driver:`PHP </php>`
- ``1.6.0+``
- `PHP Driver Quickstart <https://docs.mongodb.com/php-library/current/tutorial/client-side-encryption/>`__
- `PHP Driver Quickstart <https://www.mongodb.com/docs/php-library/current/tutorial/client-side-encryption/>`__

* - `Ruby <https://docs.mongodb.com/ruby-driver/current/>`__
* - :ruby:`Ruby </>`
- ``2.12.1+``
- `Ruby Driver Quickstart <https://docs.mongodb.com/ruby-driver/current/tutorials/client-side-encryption/>`__
- :ruby:`Ruby Driver Quickstart </tutorials/client-side-encryption/>`

Please refer to the driver reference documentation for syntax and
implementation examples.
Expand Down
4 changes: 2 additions & 2 deletions source/includes/driver-examples/driver-example-indexes-1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@
- id: nodejs
content: |
To create an index using the
`Node.JS driver <https://docs.mongodb.com/drivers/node/current/>`_,
`Node.JS driver <https://www.mongodb.com/docs/drivers/node/current/>`_,
use ``createIndex()``.

.. code-block:: javascript
Expand All @@ -161,7 +161,7 @@
- id: php
content: |
To create an index using the
`PHP driver <https://docs.mongodb.com/php-library/current/>`_, use
`PHP driver <https://www.mongodb.com/docs/php-library/current/>`_, use
:phpmethod:`MongoDB\\Collection::createIndex() <phpmethod.MongoDB\\Collection::createIndex>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

For more information on the MongoDB Compass Query Bar, see the
Compass
`Query Bar <https://docs.mongodb.com/compass/master/query-bar/>`_
:compass:`Query Bar </query-bar>`
documentation.

- id: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
This page provides examples of |query_operations| using the
:phpmethod:`MongoDB\\Collection::find() <phpmethod.MongoDB\\Collection::find>`
method in the
`MongoDB PHP Library <https://docs.mongodb.com/php-library/master/>`_.
`MongoDB PHP Library <https://www.mongodb.com/docs/drivers/php-libraries/>`_.
The examples on this page use the ``inventory`` collection. To
populate the ``inventory`` collection, run the following:

Expand All @@ -92,7 +92,7 @@
This page provides examples of |query_operations| using the
:ruby-api:`Mongo::Collection#find()<Collection.html#find-instance_method>`
method in the
`MongoDB Ruby Driver <https://docs.mongodb.com/ruby-driver/master/>`_.
:ruby:`MongoDB Ruby Driver </>`.
The examples on this page use the ``inventory`` collection. To
populate the ``inventory`` collection, run the following:

Expand Down
2 changes: 1 addition & 1 deletion source/includes/fact-uuid-restore-from-backup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@
present, MongoDB generates a UUID for the restored collection.
For more information on collection UUIDs, see
`Collections <https://docs.mongodb.com/v3.6/core/databases-and-collections/#collections>`_.
`Collections <https://www.mongodb.com/docs/v3.6/core/databases-and-collections/#collections>`_.
2 changes: 1 addition & 1 deletion source/includes/list-4.2-drivers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

- :api:`Python 3.9.0 <pymongo>`

- `Ruby 2.10.0 <https://docs.mongodb.com/ruby-driver/current/>`__
- :ruby:`Ruby 2.10.0 </>`

- `Scala 2.7.0 <https://mongodb.github.io/mongo-scala-driver/>`__

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,25 +18,25 @@ version of MongoDB products:
- |checkmark|


* - `BI Connector <https://docs.mongodb.com/bi-connector/v2.0/>`__
* - :bic:`BI Connector </>`
- |checkmark|
- |checkmark|
- |checkmark|
-

* - `Compass <https://docs.mongodb.com/compass/current/>`__
* - :compass:`Compass </>`
- |checkmark|
-
-
-

* - `Spark Connector <https://docs.mongodb.com/spark-connector/v2.0/>`__
* - `Spark Connector <https://www.mongodb.com/docs/spark-connector/v2.0/>`__
- |checkmark|
-
-
-

* - `Ops Manager <https://docs.opsmanager.mongodb.com/current/>`__
* - :opsmgr:`Ops Manager </>`
- |checkmark|
-
-
Expand Down
4 changes: 2 additions & 2 deletions source/includes/upgrade-guidance-checklists.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://docs.mongodb.com/drivers/>`_ 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
Expand Down
Loading

0 comments on commit 0a02db5

Please sign in to comment.