DOCSP-8644 install doc and availability updates

README.md

@@ -1,7 +1,20 @@
 # docs-commandline-tools
-This repository contains documentation for the MongoDB commandline tools (v4.4+)
+This repository contains documentation for the MongoDB Database Tools
+(`mongoimport`, `mongoexport`, etc.). Beginning with MongoDB 4.4, the
+Database Tools are released separately from the core server package.
+Consequently, the MongoDB Database Tools documentation has also been
+moved to its own repository, maintained here, and is no longer part of
+the core Server Manual from version 4.4 onwards.
 
-This project is currently under construction. Please pardon our dust!
+The documentation for previous versions of the Database Tools can be
+found in the Server Manual repository:
+
+- https://github.com/mongodb/docs
+
+The live documentation for the Database Tools can be found at the
+following URL:
+
+- https://docs.mongodb.com/database-tools/
 
 Report Issues
 -------------

source/bsondump.txt

@@ -12,6 +12,7 @@
    :depth: 1
    :class: singlecol
 
+.. |arrow| unicode:: U+27A4
 .. |tool-binary| replace:: :binary:`~bin.bsondump`
 
 Synopsis
@@ -21,42 +22,49 @@ The :binary:`~bin.bsondump` converts :term:`BSON` files into human-readable
 formats, including :term:`JSON`. For example, :binary:`~bin.bsondump` is useful
 for reading the output files generated by :binary:`~bin.mongodump`.
 
-.. include:: /includes/extracts/require-cmd-line-bsondump.rst
-
 .. important:: :binary:`~bin.bsondump` is a diagnostic tool for inspecting
    BSON files, not a tool for data ingestion or other application use.
 
 :binary:`~bin.bsondump` uses :manual:`Extended JSON v2.0
 (Canonical mode) </reference/mongodb-extended-json>`
 to format its data.
 
-.. include:: /includes/extracts/dbtool-new-release.rst
+.. include:: /includes/extracts/require-cmd-line-bsondump.rst
 
-.. note::
+Versioning
+~~~~~~~~~~
 
-   This documentation is for {+release+} of :binary:`~bin.bsondump`. 
-
-   For documentation on the MongoDB 4.2 or earlier versions of
-   ``bsondump``, reference the :manual:`MongoDB Server Documentation
-   </reference/program>` for that version of the tool:
+.. include:: /includes/extracts/dbtools-version-single.rst
 
-   *Quick links to older documentation*
+.. admonition:: Quick links to older documentation
+   :class: note
 
    - `MongoDB 4.2 bsondump <https://docs.mongodb.com/v4.2/reference/program/bsondump>`__
    - `MongoDB 4.0 bsondump <https://docs.mongodb.com/v4.0/reference/program/bsondump>`__
    - `MongoDB 3.6 bsondump <https://docs.mongodb.com/v3.6/reference/program/bsondump>`__
 
-.. include:: /includes/extracts/require-cmd-line-bsondump.rst
-
-Availability
-------------
-
-.. include:: /includes/extracts/download-from-tools-bsondump.rst
+This documentation is for version ``{+release+}`` of |tool-binary|. 
 
 Compatibility
 -------------
 
-.. include:: /includes/extracts/dbtool-compatibility-single.rst
+MongoDB Server Compatibility
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/dbtools-compatibility-single.rst
+
+Platform Support
+~~~~~~~~~~~~~~~~
+
+|tool-binary| version ``{+release+}`` is supported on the following
+platforms:
+
+.. include:: /includes/fact-platform-support.rst
+
+Installation
+------------
+
+.. include:: /includes/fact-see-install-guide.rst
 
 Options
 -------

source/includes/extracts-compatibility.yaml

@@ -1,22 +1,23 @@
 ref: dbtools-compatibility-all
 content: |
 
-   The {+dbtools+} support the following versions of the MongoDB server:
+   {+dbtools+} version ``{+release+}`` supports the following versions
+   of the MongoDB server:
 
    - MongoDB 4.4
    - MongoDB 4.2
    - MongoDB 4.0
    - MongoDB 3.6
 
-   While the tools may work on earlier versions of MongoDB server, any such
-   compatibility is not guaranteed.
+   While the tools may work on earlier versions of MongoDB server, any
+   such compatibility is not guaranteed.
 
 ---
-ref: dbtool-compatibility-single
+ref: dbtools-compatibility-single
 content: |
 
-   The |tool-binary| supports the following versions of the MongoDB
-   Server:
+   |tool-binary| version ``{+release+}`` supports the following versions
+   of the MongoDB Server:
 
    - MongoDB 4.4
    - MongoDB 4.2
@@ -25,13 +26,4 @@ content: |
 
    While |tool-binary| may work on earlier versions of MongoDB server,
    any such compatibility is not guaranteed.
----
-ref: dbtool-new-release
-content: |
-
-  |tool-binary| releases as version ``100`` and has an independent
-  release schedule from the MongoDB Server. Previously, |tool-binary|
-  was released alongside the MongoDB Server and used matching
-  versioning.
-
-...
+...

source/includes/extracts-version.yaml

@@ -0,0 +1,32 @@
+ref: dbtools-version-all
+content: |
+
+  Starting with MongoDB 4.4, the {+dbtools+} are now released separately
+  from the MongoDB Server and use their own versioning, with an initial
+  version of ``100``. Previously, these tools were released alongside
+  the MongoDB Server and used matching versioning.
+
+  For documentation on the MongoDB 4.2 or earlier versions of these
+  tools, reference the :manual:`MongoDB Server Documentation
+  </reference/program>` for that version of the tool:
+
+  .. admonition:: Quick links to older documentation
+     :class: note
+
+     - `MongoDB 4.2 Tools <https://docs.mongodb.com/v4.2/reference/program/>`__
+     - `MongoDB 4.0 Tools <https://docs.mongodb.com/v4.0/reference/program/>`__
+     - `MongoDB 3.6 Tools <https://docs.mongodb.com/v3.6/reference/program/>`__
+
+---
+ref: dbtools-version-single
+content: |
+
+  Starting with MongoDB 4.4, |tool-binary| is now released separately
+  from the MongoDB Server and uses its own versioning, with an initial
+  version of ``100``. Previously, |tool-binary| was released alongside
+  the MongoDB Server and used matching versioning.
+
+  For documentation on the MongoDB 4.2 or earlier versions of
+  |tool-binary|, reference the :manual:`MongoDB Server Documentation
+  </reference/program>` for that version of the tool:
+

source/includes/fact-platform-support.rst

@@ -0,0 +1,102 @@
+.. |checkmark| unicode:: U+2713
+
+.. list-table::
+  :header-rows: 1
+  :class: compatibility
+  :widths: 40 15 15 15 15
+
+  * -
+    - x86_64
+    - ARM64
+    - PPC64LE
+    - s390x
+
+  * - Amazon 2
+    - |checkmark|
+    -
+    -
+    -
+
+  * - Amazon 2013.03+
+    - |checkmark|
+    -
+    -
+    -
+
+  * - Debian 10
+    - |checkmark|
+    -
+    -
+    -
+
+  * - Debian 9
+    - |checkmark|
+    -
+    -
+    -
+
+  * - Debian 8
+    - |checkmark|
+    -
+    -
+    -
+
+  * - :abbr:`RHEL (Red Hat Enterprise Linux)` / CentOS 8
+    - |checkmark|
+    -
+    - |checkmark|
+    -
+
+  * - :abbr:`RHEL (Red Hat Enterprise Linux)` / CentOS 7
+    - |checkmark|
+    -
+    - |checkmark|
+    - |checkmark|
+
+  * - :abbr:`RHEL (Red Hat Enterprise Linux)` / CentOS 6
+    - |checkmark|
+    -
+    -
+    - |checkmark|
+
+  * - SUSE 12
+    - |checkmark|
+    -
+    -
+    -
+
+  * - Ubuntu 20
+    - |checkmark|
+    -
+    -
+    -
+
+  * - Ubuntu 18
+    - |checkmark|
+    - |checkmark|
+    - |checkmark|
+    - |checkmark|
+
+  * - Ubuntu 16
+    - |checkmark|
+    - |checkmark|
+    - |checkmark|
+    - |checkmark|
+
+  * - Windows 8 and later
+    - |checkmark|
+    -
+    -
+    -
+
+  * - Windows Server 2012 and later
+    - |checkmark|
+    -
+    -
+    -
+
+  * - macOS 10.12 or later
+    - |checkmark|
+    -
+    -
+    -

source/includes/fact-see-install-guide.rst

@@ -0,0 +1,6 @@
+The |tool-binary| tool is part of the *{+dbtools+}* package: 
+
+.. container::
+
+   |arrow| Follow the :ref:`{+dbtools-short+} Installation Guide
+   <install-tools>` to install |tool-binary|.