diff --git a/src/pages/docs/nav.json b/src/pages/docs/nav.json index 867e2a94..111e411e 100644 --- a/src/pages/docs/nav.json +++ b/src/pages/docs/nav.json @@ -61,6 +61,10 @@ "title": "getWordPressProps", "route": "/docs/reference/get-wordpress-props" }, + { + "title": "Telemetry", + "route": "/docs/reference/telemetry/" + }, { "title": "useAuth", "route": "/docs/reference/use-auth" diff --git a/src/pages/docs/reference/telemetry/images/telemetry-2.png b/src/pages/docs/reference/telemetry/images/telemetry-2.png new file mode 100644 index 00000000..b2707b4d Binary files /dev/null and b/src/pages/docs/reference/telemetry/images/telemetry-2.png differ diff --git a/src/pages/docs/reference/telemetry/images/telemetry-image-1.png b/src/pages/docs/reference/telemetry/images/telemetry-image-1.png new file mode 100644 index 00000000..b90e6bd3 Binary files /dev/null and b/src/pages/docs/reference/telemetry/images/telemetry-image-1.png differ diff --git a/src/pages/docs/reference/telemetry/index.mdx b/src/pages/docs/reference/telemetry/index.mdx new file mode 100644 index 00000000..9b1ab416 --- /dev/null +++ b/src/pages/docs/reference/telemetry/index.mdx @@ -0,0 +1,42 @@ +export const metadata = { + title: "Telemetry", +}; + +Faust collects completely anonymous telemetry data about general usage. Participation in this anonymous program is optional. For more information on how we handle this data, please read our [Privacy Policy](/privacy-policy). + +## What data we collect + +### WordPress Environment + +- WordPress version +- PHP version +- Faust plugin version & settings (_`frontend_uri` is not collected_) +- WordPress Multisite +- If the site is hosted on WP Engine +- Active plugins + +### Node Environment + +- `@faustwp/core` version +- `@faustwp/cli` version +- `@faustwp/blocks` version +- `@faustwp/block-editor-utils` version +- `@faustwp/experimental-app-router` version +- `@apollo/client` version +- Node version +- Next.js version +- If the Node environment is in **dev mode** (i.e., whether `npm run dev` was run) +- The command that was run (e.g., `npm run dev`, `npm run build`) +- The Operating System Platform name + +> **_NOTE:_** We do not collect any personally identifiable information or sensitive information like environment variables, file paths, or any application URLs. + +## Program Participation + +If you’d like to join the program, you can enable telemetry by selecting yes on the prompt: + +![Message displayed in WP Admin](./images/telemetry-image-1.png) + +You can also go to the Faust Settings page and toggle your participation at anytime: + +![Faust settings page showing checkbox for Telemetry](./images/telemetry-2.png)