From 8e5611bc5014576ac719eae09cd8b7498576f8b0 Mon Sep 17 00:00:00 2001 From: Amir Raminfar Date: Mon, 3 Apr 2023 12:00:15 -0700 Subject: [PATCH] Updates docs to have analytics and dashboard --- docs/.vitepress/config.ts | 1 + docs/guide/analytics.md | 15 +++++++++++++++ docs/guide/usage-dashboard.md | 9 +++++++++ 3 files changed, 25 insertions(+) create mode 100644 docs/guide/analytics.md create mode 100644 docs/guide/usage-dashboard.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index ab78cf3c..680fec68 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -67,6 +67,7 @@ export default defineConfig({ { text: "Healthcheck", link: "/guide/healthcheck" }, { text: "Remote Hosts", link: "/guide/remote-hosts" }, { text: "Supported Env Vars", link: "/guide/supported-env-vars" }, + { text: "Analytics", link: "/guide/analytics" }, ], }, { diff --git a/docs/guide/analytics.md b/docs/guide/analytics.md new file mode 100644 index 00000000..1b7798c8 --- /dev/null +++ b/docs/guide/analytics.md @@ -0,0 +1,15 @@ +--- +title: Anonymous Analytics +--- + +# Data Collection of Analytics + +Dozzle collects anonymous user configurations using Google Analytics. _Why?_ Dozzle is an open source project with no funding. As a result, there is no time to do user studies of Dozzle. Analytics is collected to prioritize features and fixes based on how people use Dozzle. This data is completely public and can be viewed live using [dashboard](/guide/usage-dashboard). + +## Where is data stored + +Dozzle's sends anonymous data to Google Analytics. Retention policy is 14 months which is lowest [possible value for Google Analytics](https://support.google.com/analytics/answer/7667196). + +## Opting out + +Dozzle analytics helps to prioritize features and spend time on most important features. If you do not want to be tracked at all, use `--no-analytics` flag or `DOZZLE_NO_ANALYTICS` env variable. diff --git a/docs/guide/usage-dashboard.md b/docs/guide/usage-dashboard.md new file mode 100644 index 00000000..9cf2b400 --- /dev/null +++ b/docs/guide/usage-dashboard.md @@ -0,0 +1,9 @@ +--- +title: Usage Dashboard +--- + +# Usage Dashboard + +This data is based on collected data which is completely anonymous. + +