Skip to content

Commit 2b7110c

Browse files
authored
chore(telemetry): add disclaimer to the doc; update new connection description COMPASS-8807 (#6653)
chore(telemetry): add disclaimer to the doc; update new connection description
1 parent 5c78505 commit 2b7110c

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

packages/compass-telemetry/src/telemetry-events.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -803,7 +803,9 @@ type NewConnectionEvent = ConnectionScopedEvent<{
803803
topology_type: string;
804804

805805
/**
806-
* The number of active connections.
806+
* The number of saved active connections (doesn't include new connections
807+
* that are not yet fully saved, like the ones created with the "New
808+
* Connection" button)
807809
*/
808810
num_active_connections: number;
809811

scripts/generate-tracking-plan.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -325,6 +325,12 @@ function generateMarkdownPlan(
325325
const markdown = `
326326
# Compass Tracking Plan
327327
328+
> [!NOTE]
329+
> This plan represents the tracking plan for the current branch / commit that
330+
> you have selected (\`main\` by default), it might not be released yet. To find
331+
> the tracking plan for the specific Compass version you can use the following
332+
> URL: https://github.com/mongodb-js/compass/blob/v<compass version>/docs/tracking-plan.md
333+
328334
Generated on ${formattedDate}
329335
330336
## Table of Contents

0 commit comments

Comments
 (0)