From 8e0cb0b9a6e0527b9baad63082c680a1db67ae7f Mon Sep 17 00:00:00 2001 From: Naveen MR Date: Sat, 16 Apr 2022 10:42:10 +0100 Subject: [PATCH 1/2] docs : usage information Signed-off-by: Naveen MR --- .../en/setup-and-usages/usage-information.md | 43 ++++++++++++++++--- 1 file changed, 36 insertions(+), 7 deletions(-) diff --git a/packages/noco-docs-prev/content/en/setup-and-usages/usage-information.md b/packages/noco-docs-prev/content/en/setup-and-usages/usage-information.md index ebaa21db18..9ee6afaea3 100644 --- a/packages/noco-docs-prev/content/en/setup-and-usages/usage-information.md +++ b/packages/noco-docs-prev/content/en/setup-and-usages/usage-information.md @@ -8,7 +8,7 @@ menuTitle: 'Usage Information' -NocoDB is a fast growing open source project and we are committed to providing a solution that exceeds the expectations of the users and community. +NocoDB is a fast growing open source project which is UI heavy and we are committed to providing a solution that exceeds the expectations of the users and community. We are also committed to continuing to develop and make NocoDB even better than it is today. To that end, NocoDB contains a feature in which anonymous and otherwise non-sensitive data is collected. This anonymous and non-sensitive data gives a better understanding of how users are interacting and using the product. @@ -18,19 +18,49 @@ We will always continue to do hands-on UI/UX testing, surveys, issue tracking an Otherwise talk with the Community while striving to understand and deliver what is being asked for and what is needed, by any means available. -However, these above actions alone are often insufficient to maintain an overall picture of the product usage. +However, these above actions alone are often insufficient +- To maintain an overall picture of the product usage. +- Prioritising the efforts. +- Impact of any breaking changes. +- To understand whether UI improvements are helpful to users. ## What we collect ? -The following data is collected: +We collect actions made on models (project, table, view, sharedView, user, hook, image, sharedBase etc) periodically with : - Unique machine ID (generated with node-machine-id) - Environment (dev, staging, production) - System information (OS, node version, docker or npm) -- Failures and errors. -- Create and delete events of a project, table, view, linkToAnotherRecord, sharedView, user, hook, image, sharedBase. +- Failures. +Here is an example : +``` +{ + "machine_id" : "a0885e8e6a38d9fbb5d39e7d04a44da7773d4f", + "evt_type": "project:created" + "package_id" : "0.84.15", + "os_type" : "Linux", + "os_platform" : "linux", + "os_release" : "5.10.25-linuxkit", + "node_version" : "14.18.2", + "docker" : "true", + "xc_version" : "0.84.15", + "env" : "dev", +} + +``` + +Our UI Dashboard is a Vuejs-Nuxtjs app. Actions taken on UI with completely anonymized route names are sent as payload. + +Here is an example : +``` +{ + "id": "a0885e8e6a38d9fbb5d39e7d04a44da7773d4f", + "event": "table:create", + "path": "/nc/:project_id", +} +``` ## What we DO NOT collect ? -We do not collect private or sensitive information, such as: +We do not collect any private or sensitive information, such as: - Personally identifiable information - Credential information (endpoints, ports, DB connections, username/password) - User data @@ -39,4 +69,3 @@ We do not collect private or sensitive information, such as: ## Opt-out To disable usage information collection please set following environment variable. > NC_DISABLE_TELE=true - From d6e7b67d059f1387f5c1693816a0653e4db0c856 Mon Sep 17 00:00:00 2001 From: Naveen MR Date: Sat, 16 Apr 2022 10:52:32 +0100 Subject: [PATCH 2/2] docs : usage information Signed-off-by: Naveen MR --- .../en/setup-and-usages/usage-information.md | 56 ++++++++++++++----- 1 file changed, 42 insertions(+), 14 deletions(-) diff --git a/packages/noco-docs/content/en/setup-and-usages/usage-information.md b/packages/noco-docs/content/en/setup-and-usages/usage-information.md index 12792ccb03..d240b8dba6 100644 --- a/packages/noco-docs/content/en/setup-and-usages/usage-information.md +++ b/packages/noco-docs/content/en/setup-and-usages/usage-information.md @@ -6,38 +6,66 @@ category: 'Product' menuTitle: 'Usage Information' --- -NocoDB is a fast growing open source project and we are committed to providing a solution that exceeds the expectations of the users and community. + + +NocoDB is a fast growing open source project which is UI heavy and we are committed to providing a solution that exceeds the expectations of the users and community. We are also committed to continuing to develop and make NocoDB even better than it is today. To that end, NocoDB contains a feature in which anonymous and otherwise non-sensitive data is collected. This anonymous and non-sensitive data gives a better understanding of how users are interacting and using the product. ## Context -We will always continue to do hands-on UI/UX testing, surveys, issue tracking and roadmap. -Otherwise talk with the Community while striving to understand +We will always continue to do hands-on UI/UX testing, surveys, issue tracking and roadmap. +Otherwise talk with the Community while striving to understand and deliver what is being asked for and what is needed, by any means available. -However, these above actions alone are often insufficient to maintain an overall picture of the product usage. +However, these above actions alone are often insufficient +- To maintain an overall picture of the product usage. +- Prioritising the efforts. +- Impact of any breaking changes. +- To understand whether UI improvements are helpful to users. ## What we collect ? -The following data is collected: +We collect actions made on models (project, table, view, sharedView, user, hook, image, sharedBase etc) periodically with : - Unique machine ID (generated with node-machine-id) - Environment (dev, staging, production) - System information (OS, node version, docker or npm) -- Failures and errors. -- Create and delete events of a project, table, view, linkToAnotherRecord, sharedView, user, hook, image, sharedBase. +- Failures. + +Here is an example : +``` +{ + "machine_id" : "a0885e8e6a38d9fbb5d39e7d04a44da7773d4f", + "evt_type": "project:created" + "package_id" : "0.84.15", + "os_type" : "Linux", + "os_platform" : "linux", + "os_release" : "5.10.25-linuxkit", + "node_version" : "14.18.2", + "docker" : "true", + "xc_version" : "0.84.15", + "env" : "dev", +} + +``` +Our UI Dashboard is a Vuejs-Nuxtjs app. Actions taken on UI with completely anonymized route names are sent as payload. + +Here is an example : +``` +{ + "id": "a0885e8e6a38d9fbb5d39e7d04a44da7773d4f", + "event": "table:create", + "path": "/nc/:project_id", +} +``` ## What we DO NOT collect ? -We do not collect private or sensitive information, such as: -- Personally identifiable information +We do not collect any private or sensitive information, such as: +- Personally identifiable information - Credential information (endpoints, ports, DB connections, username/password) - User data ## Opt-out To disable usage information collection please set following environment variable. - - -```bash -NC_DISABLE_TELE=true -``` \ No newline at end of file +> NC_DISABLE_TELE=true