Telemetry notices (#1122)

* Add telemetry notice to faustjs.org site and update collected info list

* Add privacy policy to legacy faust site

* Add telemetry to sidebar

* Update docs site scripts for Atlas

internal/faustjs.org/docs/telemetry.mdx

@@ -1,31 +1,28 @@
 ---
 slug: telemetry
 title: Telemetry
-description: We use Telemetry in Faust.js to help us understand how users use our projects.
+description: We use Telemetry in Faust to help us understand how users use our projects.
 ---
 
-Faust.js has opt-in telemetry for both the FaustWP plugin and Faust package. The plugin and package both collect information to help us make more informed product decisions.
+Faust has opt-in telemetry for both the Faust plugin and Faust packages. The plugin and packages both collect information to help us make more informed product decisions.
 
 ## What is being collected?
 
 Once you opt-in, faust will collect the following information at build time:
 
-### Faust
-
-- Faust version
-- Next.js version
-- Node.js version
-- Apollo Client version
-- If the command is running in a development environment
-
-### Faust Plugin
-
+- Which settings are enabled/disabled in the Faust plugin
+- Faust plugin version
+- If the WordPress site is hosted on WP Engine
+- If the WordPress site is multisite
+- PHP version of the WordPress site
 - WordPress version
-- FaustWP version
-- PHP version
-- FaustWP settings (excluding any URLs)
-- If the site is multisite
-- If the site is hosted with WP Engine
+- `@faustwp/core` version
+- `@faustwp/cli` version
+- `@apollo/client` version
+- Node version
+- Next.js Version
+- If the node environment is in dev mode (was `npm run dev` ran)
+- The command that is ran (i.e. `npm run dev`, `npm run build`)
 
 :::info
 We **do not** collect any personally identifiable information or sensitive information like environment variables, file paths, or any application URLs.

internal/faustjs.org/package.json

@@ -3,13 +3,12 @@
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
-    "start": "docusaurus start",
+    "dev": "docusaurus start",
+    "start": "docusaurus serve",
     "build": "docusaurus build",
     "swizzle": "docusaurus swizzle",
     "deploy": "docusaurus deploy",
     "clear": "docusaurus clear",
-    "serve": "docusaurus serve",
-    "serve:prod": "npm run serve -- --build --port 8080 --host 0.0.0.0",
     "write-translations": "docusaurus write-translations",
     "write-heading-ids": "docusaurus write-heading-ids"
   },

internal/legacy.faustjs.org/docs/telemetry.mdx

@@ -0,0 +1,52 @@
+---
+slug: telemetry
+title: Telemetry
+description: We use Telemetry in Faust to help us understand how users use our projects.
+---
+
+:::caution Notice
+Please note, We only collect telemetry data when using the `@faustwp/cli` package.
+:::
+
+Faust has opt-in telemetry for both the Faust plugin and Faust packages. The plugin and packages both collect information to help us make more informed product decisions.
+
+## What is being collected?
+
+Once you opt-in, faust will collect the following information at build time:
+
+- Which settings are enabled/disabled in the Faust plugin
+- Faust plugin version
+- If the WordPress site is hosted on WP Engine
+- If the WordPress site is multisite
+- PHP version of the WordPress site
+- WordPress version
+- `@faustwp/core` version
+- `@faustwp/cli` version
+- `@apollo/client` version
+- Node version
+- Next.js Version
+- If the node environment is in dev mode (was `npm run dev` ran)
+- The command that is ran (i.e. `npm run dev`, `npm run build`)
+
+:::info
+We **do not** collect any personally identifiable information or sensitive information like environment variables, file paths, or any application URLs.
+:::
+
+## How do I enable/disable telemetry?
+
+Telemetry in Faust.js is opt-in by default, meaning we won't collect any telemetry information unless you explicitly enable it.
+
+If this is your first time using the `faust` cli, you will be prompted for your telemetry preferences:
+
+<a href="/docs/img/telemetry-cli-prompt.png" target="_blank">
+  <img
+    src="/docs/img/telemetry-cli-prompt.png"
+    alt="Screenshot of the Telemetry prompt in the Faust package"
+  />
+</a>
+
+Once your preferences have been set, you can run the following command to see the prompt again to change your preferences:
+
+```sh
+npx faust faust-telemetry
+```

internal/legacy.faustjs.org/docusaurus.config.js

@@ -99,6 +99,10 @@ module.exports = {
               label: 'Getting Started',
               to: '/docs/next/getting-started',
             },
+            {
+              label: 'Privacy Policy',
+              to: '/docs/privacy-policy',
+            },
           ],
         },
         {

internal/legacy.faustjs.org/package.json

@@ -4,7 +4,8 @@
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
-    "start": "npm run downloadChangelogs && docusaurus start",
+    "dev": "npm run downloadChangelogs && docusaurus start",
+    "start": "npm run downloadChangelogs && docusaurus serve",
     "build": "npm run downloadChangelogs && docusaurus build",
     "swizzle": "docusaurus swizzle",
     "deploy": "docusaurus deploy",

internal/legacy.faustjs.org/sidebars.js

@@ -285,5 +285,10 @@ module.exports = {
         },
       ],
     },
+    {
+      type: 'doc',
+      label: 'Telemetry',
+      id: 'telemetry',
+    },
   ],
 };