From cc5b5dd1c84b41160239888619fbeeba4b8cd2e5 Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Wed, 29 Nov 2017 15:19:50 -0500 Subject: [PATCH] Updates per Kay's feedback --- source/includes/fact-install-windows.rst | 3 ++ source/installation.txt | 9 ++++ source/reference/program.txt | 18 ++++++- source/reference/program/install_compass.txt | 54 +++++++++++++++++++ source/release-notes/3.6.txt | 9 ++++ .../install-mongodb-enterprise-on-windows.txt | 1 - 6 files changed, 91 insertions(+), 3 deletions(-) create mode 100644 source/reference/program/install_compass.txt diff --git a/source/includes/fact-install-windows.rst b/source/includes/fact-install-windows.rst index 147651f5f8a..f5e49362347 100644 --- a/source/includes/fact-install-windows.rst +++ b/source/includes/fact-install-windows.rst @@ -11,6 +11,9 @@ installation option. These instructions assume that you have installed MongoDB to ``C:\Program Files\MongoDB\Server\3.6\``. +During the installation process you will be given the option to install +:ref:`MongoDB Compass ` in addition to MongoDB Server. + MongoDB is self-contained and does not have any other system dependencies. You can run MongoDB from any folder you choose. You may install MongoDB in any folder (e.g. ``D:\test\mongodb``). diff --git a/source/installation.txt b/source/installation.txt index 299ca4ff56d..a4781468a93 100644 --- a/source/installation.txt +++ b/source/installation.txt @@ -23,6 +23,15 @@ MongoDB. For upgrade instructions, see :ref:`3.6-upgrade` instead. +.. note:: + + .. versionadded:: 3.6 + + Each MongoDB installer is packaged with a platform-specific + :ref:`MongoDB Compass ` installation script. This + script installs MongoDB Compass as part of the MongoDB Server + installation process. + Supported Platforms ------------------- diff --git a/source/reference/program.txt b/source/reference/program.txt index 4acde047cf3..3dbbd8d3c09 100644 --- a/source/reference/program.txt +++ b/source/reference/program.txt @@ -47,9 +47,9 @@ Binary Import and Export Tools dump files from the :program:`mongod` instances, while :program:`mongorestore` makes it possible to restore these dumps. :program:`bsondump` converts BSON dump files into -:term:`JSON`. +:term:`JSON`. -.. deprecated:: 3.2 +.. deprecated:: 3.2 :program:`mongooplog` @@ -116,3 +116,17 @@ GridFS :maxdepth: 1 /reference/program/mongofiles + +MongoDB Compass +--------------- + +.. versionadded:: 3.6 + + MongoDB is packaged with an :program:`install_compass` script, which + is a platform-specific installer for + :ref:`MongoDB Compass Community Edition `. + +.. toctree:: + :maxdepth: 1 + + /reference/program/install_compass \ No newline at end of file diff --git a/source/reference/program/install_compass.txt b/source/reference/program/install_compass.txt new file mode 100644 index 00000000000..47869997cde --- /dev/null +++ b/source/reference/program/install_compass.txt @@ -0,0 +1,54 @@ +.. _install-compass: + +:orphan: + +=================== +``install_compass`` +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +.. versionadded:: 3.6 + +Synopsis +-------- + +:program:`install_compass` is a platform-specific installation script +for :ref:`MongoDB Compass Community Edition `. + +Installation +------------ + +Linux / MacOS +~~~~~~~~~~~~~ + +On Linux / MacOS systems, navigate to the directory where the +``install_compass`` script was downloaded and run the following command +to execute the script and install MongoDB Compass: + +.. class:: copyable-code +.. code-block:: sh + + python install_compass + +Windows +~~~~~~~ + +On Windows systems, the ``install_compass`` script is a PowerShell +script included in the the MongoDB Server archive download. + +Navigate to the directory where the ``Install-Compass.ps1`` file was +downloaded and run the following command to execute the script and +install MongoDB Compass: + +.. class:: copyable-code +.. code-block:: none + + powershell .\Install-Compass.ps1 + diff --git a/source/release-notes/3.6.txt b/source/release-notes/3.6.txt index 0e41204d623..0926363f699 100644 --- a/source/release-notes/3.6.txt +++ b/source/release-notes/3.6.txt @@ -483,6 +483,15 @@ Sharded Clusters General Enhancements -------------------- +MongoDB Compass Packaging +~~~~~~~~~~~~~~~~~~~~~~~~~ + +The MongoDB Server download is packaged with a platform-specific +:doc:`installation script ` for +:ref:`MongoDB Compass Community Edition `. This +script installs MongoDB Compass as part of the MongoDB Server +installation process. + Collection Identifier ~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/tutorial/install-mongodb-enterprise-on-windows.txt b/source/tutorial/install-mongodb-enterprise-on-windows.txt index 23c9327c78d..6a83b7ed954 100644 --- a/source/tutorial/install-mongodb-enterprise-on-windows.txt +++ b/source/tutorial/install-mongodb-enterprise-on-windows.txt @@ -24,7 +24,6 @@ support for several features related to security and monitoring. .. include:: /includes/fact-default-bind-ip-change.rst - Prerequisites -------------