LukeParke/redocly-cli
1
0
Fork 0
mirror of https://github.com/LukeHagar/redocly-cli.git synced 2025-12-06 04:21:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: documentation for telemetry + contributing guide update (#1139)

Browse Source 
Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com>
Co-authored-by: Ihor Karpiuk <ihor.karpiuk@redocly.com>
This commit is contained in:
Andrew Tatomyr
2023-06-26 21:26:19 +03:00
committed by GitHub
parent 0e46aef217
commit 0ce9cab59a
7 changed files with 148 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/usage-data.md Normal file
View File

@@ -0,0 +1,22 @@
---
title: Usage data
---
# Usage data and product metrics
Redocly CLI sends a small set of anonymized data to help us understand how the tool is used and improve it.
## What data is collected
When a command is run, the following data is collected:
* the command being run
* command exit code
* values from `REDOCLY_ENVIRONMENT`
* CLI version
* NodeJS version
Values such as file names, organization IDs, and URLs are removed, replaced by just "URL" or "file", etc.
## Opt out of data collection
To opt out, set the `REDOCLY_TELEMETRY` environment variable to `off`, or set `telemetry: off` in the `redocly.yaml` configuration file.