DOCSP-19979-compass-telemetry-options #697
Conversation
✅ Deploy Preview for docs-compass ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Thanks for picking this up @jeff-allen-mongo ! I left a few comments and questions for your consideration.
source/settings/telemetry.txt
Outdated
| - The type of MongoDB deployment |compass-short| is connected to. For | ||
| example, Enterprise Edition, Community Edition, or Atlas Data Lake. | ||
|
|
||
| - User actions performed in |compass-short|, such as creating | ||
| collections and indexes. |compass-short| only tracks the general | ||
| action performed, and does not track field values or namespaces. |
There was a problem hiding this comment.
[suggestion] for active voice, although I can see this being a case where passive voice is appropriate
| - The type of MongoDB deployment |compass-short| is connected to. For | |
| example, Enterprise Edition, Community Edition, or Atlas Data Lake. | |
| - User actions performed in |compass-short|, such as creating | |
| collections and indexes. |compass-short| only tracks the general | |
| action performed, and does not track field values or namespaces. | |
| - The type of MongoDB deployment that you connect |compass-short| to. For | |
| example, Enterprise Edition, Community Edition, or Atlas Data Lake. | |
| - Actions that you perform in |compass-short|, such as creating | |
| collections and indexes. |compass-short| only tracks the general | |
| action and does not track field values or namespaces. |
There was a problem hiding this comment.
Thanks for these suggestions. I think using active voice works here, and this wording is an improvement!
source/settings/telemetry.txt
Outdated
| - IP addresses, hostnames, usernames, or credentials. | ||
|
|
||
| - Queries run in |compass-short|. | ||
|
|
||
| - Data stored in your MongoDB deployment. | ||
|
|
||
| - Personal identifiable information. |
There was a problem hiding this comment.
Since all of these list items are fragments, I think we can leave out the periods re the style guideline on periods
source/settings/telemetry.txt
Outdated
| .. procedure:: | ||
| :style: normal | ||
|
|
||
| .. step:: Open the Settings window |
There was a problem hiding this comment.
[suggestion] I would suggest adding a period to all of the step headings
| .. step:: Open the Settings window | |
| .. step:: Open the Settings window. |
source/settings/telemetry.txt
Outdated
|
|
||
| You can toggle telemetry in either: | ||
|
|
||
| - The |compass-short| :ref:`Settings panel <compass-settings-reference>` |
There was a problem hiding this comment.
[question] is there a reason why this is called the Settings panel in this line but the Settings window below? Is there a way to make this consistent?
| - The |compass-short| :ref:`Settings panel <compass-settings-reference>` | |
| - The |compass-short| :ref:`Settings panel <compass-settings-reference>` |
There was a problem hiding this comment.
Standardized to "window".
source/settings/telemetry.txt
Outdated
| .. step:: In the :guilabel:`Settings` window, click :guilabel:`Privacy` | ||
|
|
There was a problem hiding this comment.
[question] do you think it would be helpful to add a screenshot of the window here?
There was a problem hiding this comment.
My preference would be to omit the screenshot to help future-proof this in the event that the UI changes. I added a bit further clarification to say that "Privacy" is in the left pane of the window, which should hopefully ensure that users can find it.
|
@ltran-mdb2 thanks for the review! This is ready for another look whenever you have a chance. |
source/settings/telemetry.txt
Outdated
|
|
||
| |compass-short| *does not* track: | ||
|
|
||
| - IP addresses, hostnames, usernames, or credentials |
There was a problem hiding this comment.
We actually do track the hostname on connection in Compass. We use this information to identify an associated Atlas org when processing our telemetry data.
There was a problem hiding this comment.
That makes sense! Updating.
source/settings/telemetry.txt
Outdated
|
|
||
| - IP addresses, hostnames, usernames, or credentials | ||
|
|
||
| - Queries run in |compass-short| |
There was a problem hiding this comment.
We will soon start tracking queries generated from the GenAI feature in an anonymized way. Maybe we can reword this so it says we won't be storing queries in a way that can be associated with the user?
3 participants
DESCRIPTION
Add a task page for toggling Compass telemetry.
STAGING
Main content is on this new task page: Configure Telemetry Options
I also added links to the new page on these pages:
JIRA
https://jira.mongodb.org/browse/DOCSP-19979
Self-Review Checklist
External Review Requirements
What's expected of an external reviewer?