From 86601e8130fe19d9db1ec483a640acd1602aec0b Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Fri, 17 Jun 2022 13:53:19 +0300 Subject: [PATCH] docs: added usage documentation (#1639) * added integration * add segment for API reference * updated frontend checkout flow * added paypal documentation * Improve storefront quickstart documents * added documentation for entities * docs: disable running tests for docs * added docs contribution guidelines * Use npm2yarn where missing * added additional steps section * added notification overview * Added guidelines for sidebar labels * added how to create notification provider * added usage documentation * chore(deps): bump sqlite3 from 5.0.2 to 5.0.3 (#1453) Bumps [sqlite3](https://github.com/TryGhost/node-sqlite3) from 5.0.2 to 5.0.3. - [Release notes](https://github.com/TryGhost/node-sqlite3/releases) - [Changelog](https://github.com/TryGhost/node-sqlite3/blob/master/CHANGELOG.md) - [Commits](https://github.com/TryGhost/node-sqlite3/compare/v5.0.2...v5.0.3) * fix: Issue with cache in CI pipeline * Use npm2yarn where missing * added integration * add segment for API reference * fix double segment * updated frontend checkout flow * added documentation for entities * added docs contribution guidelines * Added guidelines for sidebar labels * added additional steps section * added notification overview * added how to create notification provider * added usage documentation Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com> --- docs/content/usage.md | 50 +++++++++++++++++++++++++++++++++++++++++++ www/docs/sidebars.js | 4 ++++ 2 files changed, 54 insertions(+) create mode 100644 docs/content/usage.md diff --git a/docs/content/usage.md b/docs/content/usage.md new file mode 100644 index 0000000000..27b18f84f4 --- /dev/null +++ b/docs/content/usage.md @@ -0,0 +1,50 @@ +# Collected Usage Information + +This document gives an overview of Medusa’s optional collected usage information, how it helps Medusa become a better platform, and how developers can opt out of this feature. + +## Overview + +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 on a live server. + +## 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 Node version is globally used? Should we focus our efforts on providing support for versions that we don’t currently support? + +## Collected Data + +The following data is being collected on your server: + +- 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 server and Medusa CLI used. + +:::info + +Data is only collected when the server is run with the command `medusa start`. + +::: + +## 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 server project to disable it: + +```bash +medusa telemetry --disable +``` diff --git a/www/docs/sidebars.js b/www/docs/sidebars.js index 17c8971519..57d9b3289f 100644 --- a/www/docs/sidebars.js +++ b/www/docs/sidebars.js @@ -26,6 +26,10 @@ module.exports = { id: "quickstart/quick-start", label: "Quickstart Guide", }, + { + type: "doc", + id: "usage", + }, { type: "category", collapsed: false,