Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCSP-37461 Connections Sidebar Page #646

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
b5e7033
DOCSP-37461 creating interact with your connections page
ltran-mdb2 Jul 15, 2024
bd71200
DOCSP-37461 creating interact with your connections page
ltran-mdb2 Jul 15, 2024
a3d1e54
DOCSP-37461 creating interact with your connections page
ltran-mdb2 Jul 15, 2024
beaca71
DOCSP-37461 creating interact with your connections page
ltran-mdb2 Jul 16, 2024
c4be004
DOCSP-37461 creating interact with your connections page
ltran-mdb2 Jul 16, 2024
415744a
DOCSP-37461 creating interact with your connections page
ltran-mdb2 Jul 16, 2024
337fabc
DOCSP-37461 Ali comments
ltran-mdb2 Jul 16, 2024
11bb3c6
DOCSP-37461 Ali comments
ltran-mdb2 Jul 16, 2024
b992c3a
DOCSP-37461 Ali comments
ltran-mdb2 Jul 16, 2024
fa74e16
Revert "DOCSP-37461 Ali comments"
ltran-mdb2 Jul 18, 2024
9580e63
Revert "DOCSP-37461 Ali comments"
ltran-mdb2 Jul 18, 2024
e2ad638
DOCSP-37461 deleting extra page
ltran-mdb2 Jul 18, 2024
84777e2
DOCSP-37461 copy edits
ltran-mdb2 Jul 19, 2024
6a7a086
DOCSP-37461 copy edits
ltran-mdb2 Jul 22, 2024
84bd682
DOCSP-37461 typo
ltran-mdb2 Jul 22, 2024
231db25
DOCSP-37461 sidebar restructure
ltran-mdb2 Jul 23, 2024
b0e884b
DOCSP-37461 sidebar restructure
ltran-mdb2 Jul 23, 2024
3edb1a6
DOCSP-37461 sidebar restructure
ltran-mdb2 Jul 23, 2024
afa4983
DOCSP-37461 sidebar restructure
ltran-mdb2 Jul 23, 2024
586ea1d
DOCSP-37461 sidebar restructure
ltran-mdb2 Jul 23, 2024
81676e6
DOCSP-37461 tech edits
ltran-mdb2 Jul 24, 2024
af74ff9
DOCSP-37461 tech edits
ltran-mdb2 Jul 24, 2024
ada016e
DOCSP-37461 move shell option
ltran-mdb2 Jul 25, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions source/connect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ For details, see :ref:`comp-command-line-connect`.
.. toctree::
:titlesonly:

/connect/connections
/connect/connect-from-the-command-line
/connect/advanced-connection-options
/connect/favorite-connections
Expand Down
77 changes: 77 additions & 0 deletions source/connect/connections.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
.. _compass-sidebar:

===============
Compass Sidebar
===============

.. default-domain:: mongodb

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

.. note::

.. include:: /includes/multiple-connections.rst


The Compass sidebar on the left of the Compass window
contains the following options:

- :icon-lg:`Plus` icon to add new connections
- :icon-fa5:`ellipsis-h` icon to import and export data
- Search bar to search connections
- :guilabel:`Connections` list

Connections List
----------------

The :guilabel:`Connections` list in the sidebar contains your
:ref:`favorite <favorite-connections>` and saved connections. Favorite
connections have a :icon-fa5:`star` next to the connection name. The
:guilabel:`Connections` list displays favorite connections in alphabetical
order first.

Connect to MongoDB
------------------

To connect to a saved or favorite deployment, click the name of the
connection in the :guilabel:`Connections` list. Once you connect,
Compass shows a success toast and displays a green dot next to the
connection name.

If a connection error occurs, Compass shows a toast with error
information and displays a red triangle next to the connection name. To
see additional error information, click :guilabel:`Review` in the error

Check failure on line 47 in source/connect/connections.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules

[vale] reported by reviewdog 🐶 [MongoDB.ConciseTerms] 'more' is preferred over 'additional'. Raw Output: {"message": "[MongoDB.ConciseTerms] 'more' is preferred over 'additional'.", "location": {"path": "source/connect/connections.txt", "range": {"start": {"line": 47, "column": 5}}}, "severity": "ERROR"}
toast.

To add a new connection to Compass, click the :icon-lg:`Plus` button at
the top of the :guilabel:`Connections Sidebar` to open the
:guilabel:`New Connection` modal. For more information, see
:ref:`connect-run-compass`.

To switch between connections, click the name of the connection you want
to interact with to open the :guilabel:`Databases` tab. For more
information on interacting with your databases, see :ref:`database-tab`.

Connection Options
------------------

To see connection options, hover over the name of the connection in the
:guilabel:`Connections` list. Then, click on the :icon-fa5:`ellipsis-h`
icon to open a menu with the following items:

- View performance metrics
- Show connection information
- Refresh databases
- Disconnect
- Copy connection string
- Favorite (or Unfavorite)
- Duplicate
- Remove

To open the MongoDB Shell, click the :icon-lg:`Shell` icon on the right
of the connection name.

9 changes: 2 additions & 7 deletions source/databases.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,9 @@ Databases Tab

The :guilabel:`Databases` tab lists the existing databases for your
MongoDB deployment. To access the :guilabel:`Databases` tab, click the
cluster name in the upper left corner and select the
:guilabel:`Databases` tab.
deployment name in the Compass sidebar.

.. figure:: /images/compass/database-tab.png
:figwidth: 700px
:alt: Database Tab

From this view, you can click a database name in the list to view its
From this view, you can click a database name in the sidebar to view its
:doc:`collections </collections>`. Alternatively, you can view
database collections by clicking the desired database in the left-hand navigation.

Expand Down
6 changes: 3 additions & 3 deletions source/includes/steps-create-database.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
title: Click the :guilabel:`Create Database` button.
title: Open the :guilabel:`Create Database` dialog.
level: 4
ref: create-database
content: |
From the :ref:`Databases <database-tab>` tab, click the
:guilabel:`Create Database` button to bring up the
In the :guilabel:`Connections Sidebar`, click the
:icon-lg:`Plus` icon to the right of the connection name to bring up the
:guilabel:`Create Database` dialog.
---
Expand Down
Loading