From f33133ffd998893ca03c58f79d259e8fada3e7db Mon Sep 17 00:00:00 2001 From: Solomon Hykes Date: Thu, 7 Apr 2022 23:34:34 +0000 Subject: [PATCH] Docs: move CLI telemetry to guides section Signed-off-by: Solomon Hykes --- docs/core-concepts/1218-cli-telemetry.md | 20 --------------- docs/guides/1218-cli-telemetry.md | 31 ++++++++++++++++++++++++ website/sidebars.js | 3 +-- 3 files changed, 32 insertions(+), 22 deletions(-) delete mode 100644 docs/core-concepts/1218-cli-telemetry.md create mode 100644 docs/guides/1218-cli-telemetry.md diff --git a/docs/core-concepts/1218-cli-telemetry.md b/docs/core-concepts/1218-cli-telemetry.md deleted file mode 100644 index 9f6c3d9b..00000000 --- a/docs/core-concepts/1218-cli-telemetry.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -slug: /1218/cli-telemetry -displayed_sidebar: europa ---- - -# CLI Telemetry - -The dagger CLI implements telemetry that provides information about the usage from the Dagger Community. Although optional, this helps us to improve dagger by measuring the usage of the main features. - -## What is tracked? - -Command names are tracked along with the version of dagger and the platform it's running on. CLI telemetry events are anonymized for privacy purposes, they are not linked to a specific identity. - -If you want to know more, you can check the telemetry implementation in dagger's source code. - -## Can I disable the telemetry? - -Dagger implements [the DNT (Console Do Not Track) standard](https://consoledonottrack.com/). - -As a result, you can disable the telemetry by setting the environment variable `DO_NOT_TRACK=1` before running dagger. diff --git a/docs/guides/1218-cli-telemetry.md b/docs/guides/1218-cli-telemetry.md new file mode 100644 index 00000000..12bbce1d --- /dev/null +++ b/docs/guides/1218-cli-telemetry.md @@ -0,0 +1,31 @@ +--- +slug: /1218/cli-telemetry +displayed_sidebar: europa +--- + +# Understanding CLI Telemetry + +## Overview + +By default, the dagger CLI sends anonymized telemetry to dagger.io. This allows us to improve Dagger by understanding how it is used. +Telemetry is optional and can be disabled at any time. If you are willing and able to leave telemetry enabled: thank you! This will help +us better understand how Dagger is used, and will allow us to improve your experience. + +## What is tracked? + +The following information is included in telemetry: + +* Dagger version +* Platform information +* Command run +* Anonymous device ID + +We use telemetry for aggregate analysis, and do not tie telemetry events to a specific identity. + +Our telemetry implementation is open-source and can be reviewed [here](https://github.com/dagger/dagger/blob/main/telemetry/telemetry.go). + +## Disabling telemetry + +Dagger implements the [(Console Do Not Track) standard](https://consoledonottrack.com/). + +As a result, you can disable the telemetry by setting the environment variable `DO_NOT_TRACK=1` before running dagger. diff --git a/website/sidebars.js b/website/sidebars.js index f729a6e7..45534ca0 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -100,7 +100,6 @@ module.exports = { "core-concepts/client", "core-concepts/secrets", "core-concepts/what-is-cue", - "core-concepts/cli-telemetry", ], }, { @@ -108,7 +107,7 @@ module.exports = { label: "Guides", collapsible: false, collapsed: false, - items: ["guides/container-images"], + items: ["guides/container-images", "guides/cli-telemetry"], }, { type: "category",