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-44435-clarify-compass-buttons #728

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

amalhotra-mdb
Copy link
Contributor

@amalhotra-mdb amalhotra-mdb commented Mar 11, 2025

DESCRIPTION

Clarify the difference bt the "save", "connect", and "save and connect" buttons when connecting to your cluster on Compass.

STAGING

https://deploy-preview-728--docs-compass.netlify.app/connect/#connect-to-your-cluster.

JIRA

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

BUILD LOG

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?

Copy link

netlify bot commented Mar 11, 2025

Deploy Preview for docs-compass ready!

Name Link
🔨 Latest commit c61e028
🔍 Latest deploy log https://app.netlify.com/sites/docs-compass/deploys/67d1a02311c11b0008e1053a
😎 Deploy Preview https://deploy-preview-728--docs-compass.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@jmd-mongo jmd-mongo 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 this update, @amalhotra-mdb! I've left two suggestions for your consideration.

Thanks!
Joe

@@ -49,8 +49,14 @@

.. step:: Connect to your cluster.

Click :guilabel:`Save` or :guilabel:`Save & Connect` to navigate to the
|compass-short| :ref:`Home Page <compass-home-screen>`.
Click :guilabel:`Save`, :guilabel:`Connect`, or :guilabel:`Save & Connect`
Copy link
Collaborator

Choose a reason for hiding this comment

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

[suggestion]

Consider rephrasing as: "To navigate to the |compass-short| :ref:`Home Page `, click :guilabel:`Save`, :guilabel:`Connect`, or :guilabel:`Save & Connect`."

|compass-short| :ref:`Home Page <compass-home-screen>`.
Click :guilabel:`Save`, :guilabel:`Connect`, or :guilabel:`Save & Connect`
to navigate to the |compass-short| :ref:`Home Page <compass-home-screen>`.
The :guilabel:`Save` button saves your connection and closes the modal without
Copy link
Collaborator

Choose a reason for hiding this comment

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

[suggestion]

Consider bulleting these out for improved scannability.

@amalhotra-mdb amalhotra-mdb requested a review from jmd-mongo March 12, 2025 15:21
@amalhotra-mdb
Copy link
Contributor Author

Thank you for these changes, @jmd-mongo ! Changes made, back to you!

Copy link
Collaborator

@jmd-mongo jmd-mongo 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 these changes, @amalhotra-mdb! This one LGTM at this point.

Thanks,
Joe

@amalhotra-mdb amalhotra-mdb requested a review from lerouxb March 12, 2025 18:32
@amalhotra-mdb
Copy link
Contributor Author

Hi @lerouxb , could you take a look at this PR for an external review, when you get a chance? Thanks!

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.

2 participants