docs: changes to main docs sidebar (#11750)

* docs: changes to main docs sidebar * fix links * fix vale test * fix vale errors
2025-03-06 11:55:56 +02:00
parent eba3172d88
commit ecc3deb362
32 changed files with 12622 additions and 12194 deletions
@@ -0,0 +1,100 @@
+export const metadata = {
+  title: `Usage Information`,
+}
+
+# {metadata.title}
+
+At Medusa, we strive to provide the best experience for developers using our platform. For that reason, Medusa collects anonymous and non-sensitive data that provides a global understanding of how users are using Medusa.
+
+---
+
+## Purpose
+
+As an open source solution, we work closely and constantly interact with our community to ensure that we provide the best experience for everyone using Medusa. 
+
+We are capable of getting a general understanding of how developers use Medusa and what general issues they run into through different means such as our Discord server, GitHub issues and discussions, and occasional one-on-one sessions.
+
+However, although these methods can be insightful, they’re not enough to get a full and global understanding of how developers are using Medusa, especially in production.
+
+Collecting this data allows us to understand certain details such as:
+
+- What operating system do most Medusa developers use?
+- What version of Medusa is widely used?
+- What parts of the Medusa Admin are generally undiscovered by our users?
+- How much data do users manage through our Medusa Admin? Is it being used for large number of products, orders, and other types of data?
+- What Node version is globally used? Should we focus our efforts on providing support for versions that we don’t currently support?
+
+---
+
+## Medusa Application Analytics
+
+This section covers which data in the Medusa application are collected and how to opt out of it.
+
+### Collected Data in the Medusa Application
+
+The following data is being collected on your Medusa application:
+
+- Unique project ID generated with UUID.
+- Unique machine ID generated with UUID.
+- Operating system information including Node version or operating system platform used.
+- The version of the Medusa application and Medusa CLI are used.
+
+<Note>
+
+Data is only collected when the Medusa application is run with the command `medusa start`.
+
+</Note>
+
+### How to Opt Out
+
+If you prefer to disable data collection, you can do it either by setting the following environment variable to true:
+
+```bash
+MEDUSA_DISABLE_TELEMETRY=true
+```
+
+Or, you can run the following command in the root of your Medusa application project to disable it:
+
+```bash
+npx medusa telemetry --disable
+```
+
+---
+
+## Admin Analytics
+
+This section covers which data in the admin are collected and how to opt out of it.
+
+### Collected Data in Admin
+
+<Note>
+
+Users have the option to [enable or disable the anonymization](#how-to-enable-anonymization) of the collected data.
+
+</Note>
+
+The following data is being collected on your admin:
+
+- The name of the store.
+- The email of the user.
+- The total number of products, orders, discounts, and users.
+- The number of regions and their names.
+- The currencies used in the store.
+- Errors that occur while using the admin.
+
+### How to Enable Anonymization
+
+To enable anonymization of your data from the Medusa Admin:
+
+1. Go to Settings → Personal Information.
+2. In the Usage insights section, click on the “Edit preferences” button.
+3. Enable the "Anonymize my usage data” toggle.
+4. Click on the “Submit and close” button.
+
+### How to Opt-Out
+
+To opt out of analytics collection in the Medusa Admin, set the following environment variable:
+
+```bash
+MEDUSA_FF_ANALYTICS=false
+```