Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/pages/docs/nav.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 42 additions & 0 deletions src/pages/docs/reference/telemetry/index.mdx
Original file line number Diff line number Diff line change
@@ -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)
Loading