Compact links in docs-ecosystem (#570)

Chris Cho · web-flow · commit 41b8bad3c828 · 2019-11-11T18:16:05.000-05:00
* add script to compact links, apply to existing docs
diff --git a/source/drivers/c.txt b/source/drivers/c.txt
@@ -45,7 +45,7 @@ See `Installing the MongoDB C Driver (libmongoc) and BSON library (libbson)
 Connect to MongoDB Atlas
 ------------------------
 
-To connect to a `MongoDB Atlas <https://docs.atlas.mongodb.com/>`_ cluster, use the `Atlas connection string <https://docs.atlas.mongodb.com/driver-connection>`__ for your cluster:
+To connect to a :atlas:`MongoDB Atlas </>` cluster, use the :atlas:`Atlas connection string </driver-connection>` for your cluster:
 
 .. code-block:: c
 
@@ -103,6 +103,6 @@ How to get help
 - Join our `Google Group <http://groups.google.com/group/mongodb-user>`__.
 - Ask on `Stack Overflow <http://stackoverflow.com/questions/tagged/mongodb-c>`__.
 - Visit our `Support Channels <http://www.mongodb.org/about/support>`__.
-- File a bug or feature request on `JIRA <https://jira.mongodb.org/browse/CDRIVER>`__.
+- File a bug or feature request on :issue:`JIRA <CDRIVER>`.
 
 
diff --git a/source/drivers/csharp.txt b/source/drivers/csharp.txt
@@ -24,7 +24,7 @@ with MongoDB.
 
 - `Usage Guide <http://mongodb.github.io/mongo-csharp-driver/?jmp=docs>`__
 
-- `API Reference <http://api.mongodb.com/csharp/current?jmp=docs>`_
+- :api:`API Reference <csharp/current?jmp=docs>`
 
 - :csharp-docs-latest:`Changelog </what_is_new/>`
 
@@ -43,7 +43,7 @@ For more information, see :csharp-docs-latest:`Installation
 Connect to MongoDB Atlas
 ------------------------
 
-To connect to a `MongoDB Atlas <https://docs.atlas.mongodb.com/>`_ cluster, use the `Atlas connection string <https://docs.atlas.mongodb.com/driver-connection>`__ for your cluster:
+To connect to a :atlas:`MongoDB Atlas </>` cluster, use the :atlas:`Atlas connection string </driver-connection>` for your cluster:
 
 .. code-block:: csharp
 
diff --git a/source/drivers/cxx.txt b/source/drivers/cxx.txt
@@ -40,7 +40,7 @@ See `Installing the mongocxx driver <http://mongocxx.org/mongocxx-v3/installatio
 Connect to MongoDB Atlas
 ------------------------
 
-To connect to a `MongoDB Atlas <https://docs.atlas.mongodb.com/>`_ cluster, use the `Atlas connection string <https://docs.atlas.mongodb.com/driver-connection>`__ for your cluster:
+To connect to a :atlas:`MongoDB Atlas </>` cluster, use the :atlas:`Atlas connection string </driver-connection>` for your cluster:
 
 .. code-block:: cpp
 
diff --git a/source/drivers/go.txt b/source/drivers/go.txt
@@ -47,7 +47,7 @@ See `Installation <https://github.com/mongodb/mongo-go-driver#installation>`__
 Connect to MongoDB Atlas
 ------------------------
 
-To connect to a `MongoDB Atlas <https://docs.atlas.mongodb.com/>`_ cluster, use the `Atlas connection string <https://docs.atlas.mongodb.com/driver-connection>`__ for your cluster:
+To connect to a :atlas:`MongoDB Atlas </>` cluster, use the :atlas:`Atlas connection string </driver-connection>` for your cluster:
 
 .. code-block:: go
 
@@ -82,7 +82,7 @@ How to get help
 - Join our `Google Group <https://groups.google.com/forum/#!forum/mongodb-go-driver>`__.
 - Ask on `Stack Overflow <https://stackoverflow.com/questions/tagged/mongo-go>`__.
 - Visit our `Support Channels <https://docs.mongodb.com/manual/support/>`__.
-- See the `project JIRA <https://jira.mongodb.org/browse/GODRIVER>`__ to raise issues or request features.
+- See the :issue:`project JIRA <GODRIVER>` to raise issues or request features.
 
 
 
diff --git a/source/drivers/java.txt b/source/drivers/java.txt
@@ -54,7 +54,7 @@ management system. See
 Connect to MongoDB Atlas
 ------------------------
 
-To connect to a `MongoDB Atlas <https://docs.atlas.mongodb.com/>`_ cluster, use the `Atlas connection string <https://docs.atlas.mongodb.com/driver-connection>`__ for your cluster:
+To connect to a :atlas:`MongoDB Atlas </>` cluster, use the :atlas:`Atlas connection string </driver-connection>` for your cluster:
 
 .. code-block:: java
 
diff --git a/source/drivers/motor.txt b/source/drivers/motor.txt
@@ -50,7 +50,7 @@ Motor on all platforms:
 Connect to MongoDB Atlas
 ------------------------
 
-To connect to a `MongoDB Atlas <https://docs.atlas.mongodb.com/>`_ cluster, use the `Atlas connection string <https://docs.atlas.mongodb.com/driver-connection>`__ for your cluster:
+To connect to a :atlas:`MongoDB Atlas </>` cluster, use the :atlas:`Atlas connection string </driver-connection>` for your cluster:
 
 .. code-block:: python
 
diff --git a/source/drivers/node.txt b/source/drivers/node.txt
@@ -63,8 +63,8 @@ This will download the MongoDB driver and add a dependency entry in your package
 Connect to MongoDB Atlas
 ------------------------
 
-To connect to a `MongoDB Atlas <https://docs.atlas.mongodb.com/>`_ cluster, use the
-`Atlas connection string <https://docs.atlas.mongodb.com/driver-connection>`__ for your cluster:
+To connect to a :atlas:`MongoDB Atlas </>` cluster, use the
+:atlas:`Atlas connection string </driver-connection>` for your cluster:
 
 .. code-block:: javascript
 
diff --git a/source/drivers/perl.txt b/source/drivers/perl.txt
@@ -62,7 +62,7 @@ for more information.
 Connect to MongoDB Atlas
 ------------------------
 
-To connect to a `MongoDB Atlas <https://docs.atlas.mongodb.com/>`_ cluster, use the `Atlas connection string <https://docs.atlas.mongodb.com/driver-connection>`__ for your cluster:
+To connect to a :atlas:`MongoDB Atlas </>` cluster, use the :atlas:`Atlas connection string </driver-connection>` for your cluster:
 
 .. code-block:: perl
 
diff --git a/source/drivers/php.txt b/source/drivers/php.txt
@@ -78,7 +78,7 @@ Additional installation instructions may be found in the
 Connect to MongoDB Atlas
 ------------------------
 
-To connect to a `MongoDB Atlas <https://docs.atlas.mongodb.com/>`_ cluster, use the `Atlas connection string <https://docs.atlas.mongodb.com/driver-connection>`__ for your cluster:
+To connect to a :atlas:`MongoDB Atlas </>` cluster, use the :atlas:`Atlas connection string </driver-connection>` for your cluster:
 
 .. code-block:: php
 
diff --git a/source/drivers/pymongo.txt b/source/drivers/pymongo.txt
@@ -17,11 +17,11 @@ Introduction
 
 **PyMongo** is the recommended way to work with MongoDB from Python.
 
-- `Tutorial <http://api.mongodb.com/python/current/tutorial.html>`__
+- :api:`Tutorial <python/current/tutorial.html>`
 
-- `API Reference <http://api.mongodb.com/python/current/api/index.html>`_
+- :api:`API Reference <python/current/api/index.html>`
 
-- `Changelog <http://api.mongodb.com/python/current/changelog.html>`__
+- :api:`Changelog <python/current/changelog.html>`
 
 - `Source Code <https://github.com/mongodb/mongo-python-driver>`__
 
@@ -62,14 +62,14 @@ To upgrade using pip:
    $ python -m pip install --upgrade pymongo
 
 
-See `Installation <http://api.mongodb.com/python/current/installation.html>`__ for more
+See :api:`Installation <python/current/installation.html>` for more
 ways to install.
 
 
 Connect to MongoDB Atlas
 ------------------------
 
-To connect to a `MongoDB Atlas <https://docs.atlas.mongodb.com/>`_ cluster, use the `Atlas connection string <https://docs.atlas.mongodb.com/driver-connection>`__ for your cluster:
+To connect to a :atlas:`MongoDB Atlas </>` cluster, use the :atlas:`Atlas connection string </driver-connection>` for your cluster:
 
 .. code-block:: python
 
diff --git a/source/drivers/scala.txt b/source/drivers/scala.txt
@@ -41,7 +41,7 @@ The recommended way to get started using the driver in your project is with a de
 Connect to MongoDB Atlas
 ------------------------
 
-To connect to a `MongoDB Atlas <https://docs.atlas.mongodb.com/>`_ cluster, use the `Atlas connection string <https://docs.atlas.mongodb.com/driver-connection>`__ for your cluster:
+To connect to a :atlas:`MongoDB Atlas </>` cluster, use the :atlas:`Atlas connection string </driver-connection>` for your cluster:
 
 .. code-block:: scala
 
@@ -85,7 +85,7 @@ How to get help
 - Join our `Google Group <https://groups.google.com/forum/#!forum/mongodb-user>`__.
 - Ask on `Stack Overflow <https://stackoverflow.com/questions/tagged/mongodb+scala>`__.
 - Visit our `Support Channels <https://docs.mongodb.com/manual/support/>`__.
-- See our `JIRA <https://jira.mongodb.org/browse/SCALA>`__ to raise issues or request features.
+- See our :issue:`JIRA <SCALA>` to raise issues or request features.
 
 
 
diff --git a/source/drivers/specs.txt b/source/drivers/specs.txt
@@ -63,7 +63,7 @@ what they apply to.
      - |checkmark|
      -
      -
-   * - `TCP Keepalive <https://jira.mongodb.org/browse/DRIVERS-383>`_
+   * - :issue:`TCP Keepalive <DRIVERS-383>`
      - |checkmark|
      -
      -
@@ -151,7 +151,7 @@ what they apply to.
      - |checkmark|
      -
      -
-   * - `OP_INSERT, OP_UPDATE, OP_REMOVE, getLastError	<http://docs.mongodb.org/manual/reference/command/getLastError/>`_
+   * - :manual:`OP_INSERT, OP_UPDATE, OP_REMOVE, getLastError	</reference/command/getLastError/>`
      - |checkmark|
      -
      -
diff --git a/source/includes/driver-table.rst b/source/includes/driver-table.rst
@@ -13,93 +13,93 @@
      - `Releases <https://github.com/mongodb/mongo-c-driver/releases>`__
      - `Source <https://github.com/mongodb/mongo-c-driver>`__
      - `API <http://mongoc.org/>`__
-     - `JIRA <https://jira.mongodb.org/browse/CDRIVER>`__
+     - :issue:`JIRA <CDRIVER>`
      -
 
    * - :doc:`C++ </drivers/cxx>`
      - `Releases <https://github.com/mongodb/mongo-cxx-driver/releases>`__
      - `Source <https://github.com/mongodb/mongo-cxx-driver>`__
      - `API <http://mongodb.github.io/mongo-cxx-driver/api/current/>`__
-     - `JIRA <https://jira.mongodb.org/browse/CXX>`__
+     - :issue:`JIRA <CXX>`
      -
    * - :doc:`C# </drivers/csharp>`
      - `Releases <https://github.com/mongodb/mongo-csharp-driver/releases>`__
      - `Source <https://github.com/mongodb/mongo-csharp-driver>`__
      - `API <http://mongodb.github.io/mongo-csharp-driver/>`__
-     - `JIRA <https://jira.mongodb.org/browse/CSHARP>`__
+     - :issue:`JIRA <CSHARP>`
      -
 
    * - :doc:`Go </drivers/go>`
      - `Releases <https://github.com/mongodb/mongo-go-driver/releases>`__
      - `Source <https://github.com/mongodb/mongo-go-driver>`__
      - `API <https://godoc.org/github.com/mongodb/mongo-go-driver/mongo>`__
-     - `JIRA <https://jira.mongodb.org/browse/GODRIVER>`__
+     - :issue:`JIRA <GODRIVER>`
      -
 
    * - :doc:`Java </drivers/java>`
      - `Releases <https://github.com/mongodb/mongo-java-driver/releases>`__
      - `Source <https://github.com/mongodb/mongo-java-driver>`__
      - `API <https://mongodb.github.io/mongo-java-driver/>`__
-     - `JIRA <https://jira.mongodb.org/browse/JAVA>`__
+     - :issue:`JIRA <JAVA>`
      - `Course <https://university.mongodb.com/courses/M220J/about>`__
 
    * - :doc:`Node.js </drivers/node>`
      - `Releases <https://github.com/mongodb/node-mongodb-native/releases>`__
      - `Source <https://github.com/mongodb/node-mongodb-native>`__
      - `API <https://mongodb.github.io/node-mongodb-native/>`__
-     - `JIRA <https://jira.mongodb.org/browse/NODE>`__
+     - :issue:`JIRA <NODE>`
      - `Course <https://university.mongodb.com/courses/M220JS/about>`__
 
    * - :doc:`Perl </drivers/perl>`
      - `Releases <https://metacpan.org/release/MongoDB>`__
      - `Source <https://github.com/mongodb/mongo-perl-driver>`__
      - `API <https://metacpan.org/pod/MongoDB>`__
-     - `JIRA <https://jira.mongodb.org/browse/PERL>`__
+     - :issue:`JIRA <PERL>`
      -
 
    * - :doc:`PHP </drivers/php>`
      - `Releases <http://pecl.php.net/package/mongodb>`__
      - `Source <https://github.com/mongodb/mongo-php-driver>`__
      - `API <http://php.net/mongodb>`__
-     - `JIRA <https://jira.mongodb.org/browse/PHPC>`__
+     - :issue:`JIRA <PHPC>`
      -
 
    * - :doc:`Python </drivers/python>`
      - `Releases <https://pypi.python.org/pypi/pymongo/>`__
      - `Source <https://github.com/mongodb/mongo-python-driver>`__
-     - `API <http://api.mongodb.com/python/current>`__
-     - `JIRA <https://jira.mongodb.org/browse/PYTHON>`__
+     - :api:`API <python/current>`
+     - :issue:`JIRA <PYTHON>`
      - `Course <https://university.mongodb.com/courses/M220P/about>`__
 
    * - :ref:`Motor (Python async)<python-async-driver>`
      - `Releases <https://pypi.python.org/pypi/motor/>`__
      - `Source <https://github.com/mongodb/motor>`__
      - `API <http://motor.readthedocs.org/en/stable/api/index.html>`__
-     - `JIRA <https://jira.mongodb.org/browse/MOTOR>`__
+     - :issue:`JIRA <MOTOR>`
      -
 
    * - `Ruby <https://docs.mongodb.com/ruby-driver/current/>`_
      - `Releases <https://rubygems.org/gems/mongo>`__
      - `Source <https://github.com/mongodb/mongo-ruby-driver>`__
-     - `API <http://api.mongodb.com/ruby/current/>`__
-     - `JIRA <https://jira.mongodb.org/browse/RUBY>`__
+     - :api:`API <ruby/current/>`
+     - :issue:`JIRA <RUBY>`
      -
 
    * - `Mongoid (Ruby ODM) <https://docs.mongodb.com/mongoid/current/>`_
      - `Releases <https://rubygems.org/gems/mongoid>`__
      - `Source <https://github.com/mongodb/mongoid>`__
      - `API <https://docs.mongodb.com/mongoid/7.0/api/>`__
-     - `JIRA <https://jira.mongodb.org/browse/MONGOID>`__
+     - :issue:`JIRA <MONGOID>`
      -
 
    * - :doc:`Scala </drivers/scala>`
      - `Releases <https://mongodb.github.io/mongo-scala-driver/>`__
      - `Source <https://github.com/mongodb/mongo-scala-driver>`__
      - `API <https://mongodb.github.io/mongo-scala-driver/>`__
-     - `JIRA <https://jira.mongodb.org/browse/SCALA>`__
+     - :issue:`JIRA <SCALA>`
      -
 ..
    * - :doc:`Haskell </drivers/haskell>`
      - `Releases <https://github.com/mongodb/mongodb-haskell/releases>`__
-     - `API <http://api.mongodb.com/haskell/>`__
-     - `JIRA <https://jira.mongodb.org/browse/HASKELL>`__
+     - :api:`API <haskell/>`
+     - :issue:`JIRA <HASKELL>`
diff --git a/source/platforms/amazon-ec2.txt b/source/platforms/amazon-ec2.txt
@@ -159,11 +159,11 @@ Change the default TCP keepalive time to 300 seconds. See our
 Enhanced Networking on Supported Instance Types
 ```````````````````````````````````````````````
 
-When available, enable AWS's `Enhanced Networking
-<http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking>`_ 
+When available, enable AWS's :aws-docs:`Enhanced Networking
+<AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking>` 
 for your instance. Not all instance types support Enhanced Networking.
-Refer to the `AWS documentation
-<http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking>`_
+Refer to the :aws-docs:`AWS documentation
+<AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking>`
 for more information. 
 
 Secure Instances
diff --git a/source/tools/hadoop.txt b/source/tools/hadoop.txt
@@ -28,7 +28,7 @@ comprehensive `wiki
 
 If you have questions please email the `mongodb-user Mailing List
 <http://groups.google.com/group/mongodb-user>`_. For any issues please
-file a ticket in `Jira <https://jira.mongodb.org/browse/HADOOP>`_.
+file a ticket in :issue:`Jira <HADOOP>`.
 
 This guide also includes the following documentation:
 
diff --git a/source/tutorial/backup-and-restore-mongodb-on-amazon-ec2.txt b/source/tutorial/backup-and-restore-mongodb-on-amazon-ec2.txt
@@ -104,7 +104,7 @@ Backup the Database Files
 -------------------------
 
 There are several ways to create an EBS Snapshot. The following examples use the
-`AWS command line <http://docs.aws.amazon.com/AWSEC2/latest/CommandLineReference/Welcome.html>`_
+:aws-docs:`AWS command line <AWSEC2/latest/CommandLineReference/Welcome.html>`
 tool.
 
 Find the EBS Volumes Associated with MongoDB
@@ -219,9 +219,9 @@ Create the EBS Snapshot
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 Create the snapshot for each device. Using the
-`ec2-create-snapshot <http://docs.aws.amazon.com/AWSEC2/latest/CommandLineReference/ApiReference-cmd-CreateSnapshot.html>`_
+:aws-docs:`ec2-create-snapshot <AWSEC2/latest/CommandLineReference/ApiReference-cmd-CreateSnapshot.html>`
 command, use the Volume Id for the device listed by the
-`ec2-describe-instances <http://docs.aws.amazon.com/AWSEC2/latest/CommandLineReference/ApiReference-cmd-DescribeInstances.html>`_
+:aws-docs:`ec2-describe-instances <AWSEC2/latest/CommandLineReference/ApiReference-cmd-DescribeInstances.html>`
 command.
 
 .. code-block:: sh
@@ -270,11 +270,11 @@ I/O load of the verification processing.
 Describe the Snapshots
 ~~~~~~~~~~~~~~~~~~~~~~
 
-Using the `ec2-describe-snapshots <http://docs.aws.amazon.com/AWSEC2/latest/CommandLineReference/ApiReference-cmd-DescribeSnapshots.html>`_
+Using the :aws-docs:`ec2-describe-snapshots <AWSEC2/latest/CommandLineReference/ApiReference-cmd-DescribeSnapshots.html>`
 command, find the snapshots that make up the backup. Using a filter on
 the ``description`` field, snapshots associated with the given backup are
 easily found. The search text used should match the text used in the ``-d``
-flag passed to `ec2-create-snapshot <http://docs.aws.amazon.com/AWSEC2/latest/CommandLineReference/ApiReference-cmd-CreateSnapshot.html>`_ command when the backup was made.
+flag passed to :aws-docs:`ec2-create-snapshot <AWSEC2/latest/CommandLineReference/ApiReference-cmd-CreateSnapshot.html>` command when the backup was made.
 
 .. code-block:: sh
 
@@ -287,7 +287,7 @@ flag passed to `ec2-create-snapshot <http://docs.aws.amazon.com/AWSEC2/latest/Co
 Create New Volumes Based on the Snapshots
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Using the `ec2-create-volume <http://docs.aws.amazon.com/AWSEC2/latest/CommandLineReference/ApiReference-cmd-CreateVolume.html>`_
+Using the :aws-docs:`ec2-create-volume <AWSEC2/latest/CommandLineReference/ApiReference-cmd-CreateVolume.html>`
 command, create a new volumes based on each of the snapshots that make
 up the backup.
 
@@ -305,7 +305,7 @@ up the backup.
 Attach the New Volumes to the Instance
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Using the `ec2-attach-volume <http://docs.aws.amazon.com/AWSEC2/latest/CommandLineReference/ApiReference-cmd-AttachVolume.html>`_
+Using the :aws-docs:`ec2-attach-volume <AWSEC2/latest/CommandLineReference/ApiReference-cmd-AttachVolume.html>`
 command, attach each volume to the instance where the backup will be
 verified.
 
@@ -397,9 +397,9 @@ Restore uses the same basic steps as the verification process:
 
 1. :manual:`db.shutdownServer() </reference/method/db.shutdownServer/>`
 
-2. `ec2-create-volume <http://docs.aws.amazon.com/AWSEC2/latest/CommandLineReference/ApiReference-cmd-CreateVolume.html>`_
+2. :aws-docs:`ec2-create-volume <AWSEC2/latest/CommandLineReference/ApiReference-cmd-CreateVolume.html>`
    and
-   `ec2-attach-volume <http://docs.aws.amazon.com/AWSEC2/latest/CommandLineReference/ApiReference-cmd-AttachVolume.html>`_.
+   :aws-docs:`ec2-attach-volume <AWSEC2/latest/CommandLineReference/ApiReference-cmd-AttachVolume.html>`.
 
 3. Mount the file system.
 
diff --git a/source/use-cases/client-side-field-level-encryption-guide.txt b/source/use-cases/client-side-field-level-encryption-guide.txt
@@ -227,8 +227,8 @@ uses an encryption strategy called *envelope encryption* in which keys
 used to encrypt/decrypt data (called **data encryption keys**) are
 encrypted with another key (called the **master key**). For more
 information on the features of envelope encryption and key management
-concepts, see `AWS Key Management Service Concepts
-<https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#enveloping>`_.
+concepts, see :aws-docs:`AWS Key Management Service Concepts
+<kms/latest/developerguide/concepts.html#enveloping>`.
 
 The master key, used by the MongoDB driver to create and encrypt data
 keys, should be stored remotely in a :wikipedia:`Key Management System
@@ -839,7 +839,7 @@ check out the reference docs in the server manual:
    .. tab::
       :tabid: java-sync
 
-      For additional information on CSFLE, see the `official Java driver documentation <https://mongodb.github.io/mongo-java-driver/3.11/driver/tutorials/client-side-encryption/>`_
+      For additional information on CSFLE, see the :java-docs-latest:`official Java driver documentation <driver/tutorials/client-side-encryption/>`
    .. tab::
       :tabid: nodejs
 
diff --git a/tools/compact_extlinks.py b/tools/compact_extlinks.py
