DOCSP-19979-compass-telemetry-options #697

jeff-allen-mongo · 2024-11-20T21:51:21Z

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

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?

netlify · 2024-11-20T21:51:43Z

✅ Deploy Preview for docs-compass ready!

Name	Link
🔨 Latest commit	`4970a46`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-compass/deploys/673fb44b6b1ea40008e6912a
😎 Deploy Preview	https://deploy-preview-697--docs-compass.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

ltran-mdb2

Thanks for picking this up @jeff-allen-mongo ! I left a few comments and questions for your consideration.

ltran-mdb2 · 2024-11-21T16:13:46Z

source/settings/telemetry.txt

+- 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.


[suggestion] for active voice, although I can see this being a case where passive voice is appropriate

Suggested change

- 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.

Thanks for these suggestions. I think using active voice works here, and this wording is an improvement!

ltran-mdb2 · 2024-11-21T16:16:27Z

source/settings/telemetry.txt

+- IP addresses, hostnames, usernames, or credentials.
+
+- Queries run in |compass-short|.
+
+- Data stored in your MongoDB deployment.
+
+- Personal identifiable information.


Since all of these list items are fragments, I think we can leave out the periods re the style guideline on periods

ltran-mdb2 · 2024-11-21T16:21:13Z

source/settings/telemetry.txt

+.. procedure:: 
+   :style: normal
+
+   .. step:: Open the Settings window


[suggestion] I would suggest adding a period to all of the step headings

Suggested change

.. step:: Open the Settings window

.. step:: Open the Settings window.

ltran-mdb2 · 2024-11-21T16:23:53Z

source/settings/telemetry.txt

+
+You can toggle telemetry in either: 
+
+- The |compass-short| :ref:`Settings panel <compass-settings-reference>`


[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?

Suggested change

- The |compass-short| :ref:`Settings panel <compass-settings-reference>`

- The |compass-short| :ref:`Settings panel <compass-settings-reference>`

Standardized to "window".

ltran-mdb2 · 2024-11-21T16:24:34Z

source/settings/telemetry.txt

+   .. step:: In the :guilabel:`Settings` window, click :guilabel:`Privacy`
+


[question] do you think it would be helpful to add a screenshot of the window here?

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.

…P-19979

jeff-allen-mongo · 2024-11-21T17:35:55Z

@ltran-mdb2 thanks for the review! This is ready for another look whenever you have a chance.

betsybutton · 2024-11-21T21:29:59Z

source/settings/telemetry.txt

+
+|compass-short| *does not* track:
+
+- IP addresses, hostnames, usernames, or credentials


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.

That makes sense! Updating.

betsybutton · 2024-11-21T21:32:46Z

source/settings/telemetry.txt

+
+- IP addresses, hostnames, usernames, or credentials
+
+- Queries run in |compass-short|


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?

betsybutton

LGTM!

ltran-mdb2

LGTM!

jeff-allen-mongo added 2 commits November 20, 2024 16:02

WIP

d2a3ecf

DOCSP-19979-compass-telemetry-options

53fdcd5

jeff-allen-mongo added 7 commits November 21, 2024 09:45

edits

9295ae8

undo protect connection string changes

8135a8b

edits

d12efd1

reformat steps

1082a5c

spacing

4de966f

edit

dc86e3c

wording

50789f4

ltran-mdb2 reviewed Nov 21, 2024

View reviewed changes

jeff-allen-mongo added 2 commits November 21, 2024 12:25

review feedback

9357a6b

Merge remote-tracking branch 'refs/remotes/upstream/master' into DOCS…

50f9a55

…P-19979

betsybutton reviewed Nov 21, 2024

View reviewed changes

review feedback

4970a46

betsybutton approved these changes Nov 21, 2024

View reviewed changes

ltran-mdb2 approved these changes Nov 22, 2024

View reviewed changes

jeff-allen-mongo merged commit cf8fe0a into mongodb:master Nov 22, 2024
4 of 5 checks passed

	.. step:: Open the Settings window
	.. step:: Open the Settings window.


		You can toggle telemetry in either:

		- The \|compass-short\| :ref:`Settings panel <compass-settings-reference>`

		.. step:: In the :guilabel:`Settings` window, click :guilabel:`Privacy`


		\|compass-short\| does not track:

		- IP addresses, hostnames, usernames, or credentials


		- IP addresses, hostnames, usernames, or credentials

		- Queries run in \|compass-short\|

DOCSP-19979-compass-telemetry-options #697

DOCSP-19979-compass-telemetry-options #697

Uh oh!

Conversation

jeff-allen-mongo commented Nov 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

DESCRIPTION

STAGING

JIRA

Self-Review Checklist

External Review Requirements

Uh oh!

netlify bot commented Nov 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-compass ready!

Uh oh!

ltran-mdb2 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jeff-allen-mongo commented Nov 21, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

betsybutton left a comment

Choose a reason for hiding this comment

Uh oh!

ltran-mdb2 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jeff-allen-mongo commented Nov 20, 2024 •

edited

Loading

netlify bot commented Nov 20, 2024 •

edited

Loading