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

Conversation

ltran-mdb2
Copy link
Collaborator

@ltran-mdb2 ltran-mdb2 commented Jul 16, 2024

DESCRIPTION

Create a Compass Sidebar page based on new multiple connection functionality
Note that screenshots will be added in DOCSP-37460

STAGING

https://preview-mongodbltranmdb2.gatsbyjs.io/compass/DOCSP-37461/connect/connections/
https://preview-mongodbltranmdb2.gatsbyjs.io/compass/DOCSP-37461/databases/

JIRA

https://jira.mongodb.org/browse/DOCSP-37461

BUILD LOG

https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=66967ac1fb8bd13b845a16ba

Self-Review Checklist

  • Is this free of any warnings or errors in the RST?
  • Is this free of spelling errors?
  • Is this free of grammatical errors?
  • Is this free of staging / rendering issues?
  • Are all the links working?

External Review Requirements

What's expected of an external reviewer?

@ltran-mdb2 ltran-mdb2 changed the base branch from master to multiple-connections July 16, 2024 13:51
Copy link
Collaborator

@ajhuh-mdb ajhuh-mdb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @ltran-mdb2, thanks for making these updates! Added some comments for you consider, so feel free to LMK if you want to discuss anything or have any follow-up questions.

source/manage-data.txt Outdated Show resolved Hide resolved
source/connections.txt Outdated Show resolved Hide resolved
source/connections.txt Outdated Show resolved Hide resolved
Active Connections Menu
~~~~~~~~~~~~~~~~~~~~~~~

When you activate a connection, the connection name appears in the
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[question] Can we clarify what we mean by "activate a connection" here? Is it referring to when you connect to it via connection string, or do you have to click on a connection from the Connections menu after adding the connection string for it to be active?

Copy link
Collaborator Author

@ltran-mdb2 ltran-mdb2 Jul 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a few sentences about activation (because the answer to your question is both, depending on the connection)

source/connections.txt Outdated Show resolved Hide resolved
source/connections.txt Outdated Show resolved Hide resolved
source/connections.txt Outdated Show resolved Hide resolved
source/connections.txt Outdated Show resolved Hide resolved
source/connections.txt Outdated Show resolved Hide resolved
source/connections.txt Outdated Show resolved Hide resolved
@ltran-mdb2 ltran-mdb2 changed the title DOCSP-37461 Interact with your connections page DOCSP-37461 Connections Sidebar Page Jul 16, 2024
@ltran-mdb2
Copy link
Collaborator Author

Thanks for your feedback @ajhuh-mdb ! This should be ready for another look

source/connect/connections.txt Outdated Show resolved Hide resolved
source/connect/connections.txt Outdated Show resolved Hide resolved
source/connections.txt Outdated Show resolved Hide resolved
Copy link
Collaborator

@ajhuh-mdb ajhuh-mdb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making this changes! A few more things before this is ready to go.

source/connect/connections.txt Outdated Show resolved Hide resolved
source/connect/connections.txt Outdated Show resolved Hide resolved
@ltran-mdb2
Copy link
Collaborator Author

Thanks for your feedback @ajhuh-mdb ! Could you take another look when you get a chance?

Copy link
Collaborator

@ajhuh-mdb ajhuh-mdb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM % one tiny typo!

:ref:`connect-run-compass`.

To remove a connection, hover over the name of the connection in the
:guilabel:`Connections` menu. Then, click on thfe :icon-fa5:`ellipsis-h` to
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nit] typo

Suggested change
:guilabel:`Connections` menu. Then, click on thfe :icon-fa5:`ellipsis-h` to
:guilabel:`Connections` menu. Then, click on the :icon-fa5:`ellipsis-h` to

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed! Thank you!


To connect to a deployment, click the name of the connection in the
:guilabel:`Connections` menu. Once you connect, the name
of the connection appears in the :guilabel:`Active Connections` menu.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't have a separate menu for active and other connections anymore. It is just one combined list.

@ltran-mdb2
Copy link
Collaborator Author

Thanks for the update @lerouxb ! I updated this page based on the new Compass structure. Could you take another look when you get a chance?

.. _connections-sidebar:

===================
Connections Sidebar
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it safe to call our only sidebar the connections sidebar? It also contains things that aren't connections and in future it will likely also contain streams, for example. Wondering if there's a better way to refer to the connections section in there.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this is all referring to just "connections list.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed all mentions to just say "Compass sidebar"

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 green dot next to the connection name. If a connection
error occurs, Compass shows a red triangle next to the connection name.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We also show toasts. If there's an error the error toast will stay until the user dismisses it. Iti contains a REVIEW button to see the error in the connect form modal.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a information about toasts for connections and errors.

@ltran-mdb2 ltran-mdb2 requested a review from lerouxb July 24, 2024 17:37
contains the following options:

- :icon-lg:`Plus` icon to add new connections
- :icon-lg:`Shell` icon to open the MongoDB Shell
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No shell at that level

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved the mention of the shell to the "Connection Options" section!

Copy link
Collaborator

@lerouxb lerouxb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good other than the reference to shell at the add connection level.

@sarah-olson-mongodb sarah-olson-mongodb merged commit f96b0a8 into mongodb:multiple-connections Jul 25, 2024
1 check failed
@docs-builder-bot
Copy link

sarah-olson-mongodb pushed a commit that referenced this pull request Aug 27, 2024
* DOCSP 37462 Updating Connect to MonogDB Compass page for multiple connections (#617)

* DOCSP-37462 updating connect to MongoDB Compass page

* DOCSP-37462 updating connect to MongoDB Compass page

* DOCSP-37462 updating connect to MongoDB Compass page

* DOCSP-37462 removing extra space

* DOCSP 37458 - multiple connections on Compass Home (#616)

* DOCSP-37458 multiple connections home screen update

* DOCSP-37458 multiple connections home screen update

* DOCSP-37458 copy edits

* DOCSP-37458 typo

* DOCSP-37458 adding database title

* DOCSP-37458 adding database title

* DOCSP 37463 Updating connection window flow (#647)

* DOCSP-37463 general connection tab

* DOCSP-37463 general connection tab

* DOCSP-37463 general connection tab

* DOCSP-37463 general connection tab

* DOCSP-37463 general connection tab

* DOCSP-37463 general connection tab

* DOCSP-37463 general connection tab

* DOCSP-37463 general connection tab

* DOCSP-37463 general connection tab

* DOCSP-37463 general connection tab

* DOCSP-37463 general connection tab

* DOCSP-37463 copy edits

* DOCSP-37463 copy edits

* DOCSP-37463 tech edits

* DOCSP-37463 tech edits

* DOCSP-37461 Connections Sidebar Page (#646)

* DOCSP-37461 creating interact with your connections page

* DOCSP-37461 creating interact with your connections page

* DOCSP-37461 creating interact with your connections page

* DOCSP-37461 creating interact with your connections page

* DOCSP-37461 creating interact with your connections page

* DOCSP-37461 creating interact with your connections page

* DOCSP-37461 Ali comments

* DOCSP-37461 Ali comments

* DOCSP-37461 Ali comments

* Revert "DOCSP-37461 Ali comments"

This reverts commit b992c3a.

* Revert "DOCSP-37461 Ali comments"

This reverts commit 11bb3c6.

* DOCSP-37461 deleting extra page

* DOCSP-37461 copy edits

* DOCSP-37461 copy edits

* DOCSP-37461 typo

* DOCSP-37461 sidebar restructure

* DOCSP-37461 sidebar restructure

* DOCSP-37461 sidebar restructure

* DOCSP-37461 sidebar restructure

* DOCSP-37461 sidebar restructure

* DOCSP-37461 tech edits

* DOCSP-37461 tech edits

* DOCSP-37461 move shell option

* DOCSP 37460 Updating Compass Multiple Connections Screenshots (#658)

* DOCSP-37460 updating Compass screenshots

* DOCSP-37460 updating Compass screenshots

* DOCSP-37460 ian edits

* DOCSP-42696 update Favorite Connections and  Performance page (#661)

* DOCSP-42696 update Favorite Connections page

* DOCSP-42696 update Favorite Connections page

* DOCSP-42696 update Favorite Connections page

* DOCSP-42696 update Favorite Connections page

* DOCSP-42696 adding performance

* DOCSP-42696 adding performance

* DOCSP-42696 restructuring ToC

* DOCSP-42696 restructuring ToC

* DOCSP-38430 Julia comments

* DOCSP-38430 Julia comments

* DOCSP-38430 Julia comments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants