[superset] 02/03: FAQ and opt-out documentation

[ru...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rusackas pushed a commit to branch scarf-docker-compose-helm-downloads
in repository https://gitbox.apache.org/repos/asf/superset.git

commit 612adc4b4ac54bd88461505efc4af0038505924f
Author: Evan Rusackas <ev...@rusackas.com>
AuthorDate: Fri Jul 7 17:14:25 2023 -0600

    FAQ and opt-out documentation
---
 docs/docs/frequently-asked-questions.mdx                         | 6 ++++++
 .../installation/installing-superset-using-docker-compose.mdx    | 9 ++++++++-
 docs/docs/installation/running-on-kubernetes.mdx                 | 4 ++++
 3 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/docs/docs/frequently-asked-questions.mdx b/docs/docs/frequently-asked-questions.mdx
index 381746e650..7187a73beb 100644
--- a/docs/docs/frequently-asked-questions.mdx
+++ b/docs/docs/frequently-asked-questions.mdx
@@ -282,3 +282,9 @@ guarantees and are not recommended but may fit your use case temporarily:
 In the Edit Dataset view, you can specify a time offset. This field lets you configure the
 number of hours to be added or subtracted from the time column.
 This can be used, for example, to convert UTC time to local time.
+
+### Does Superset collect any telemetry data?
+
+Superset uses [Scarf](https://about.scarf.sh/) by default to collect basic telemetry data upon installing and/or running Superset. This data helps the maintainers of Superset better understand which versions of Superset are being used, in order to prioritize patch/minor releases and security fixes.
+We use the [Scarf Gateway](https://docs.scarf.sh/gateway/) to sit in front of container registries, and the (scarf-js)[https://about.scarf.sh/package-sdks] package to track `npm` installations.
+Scarf purges PII and provides aggregated statistics. Superset users can easily opt out of analytics in various ways documented [here](https://docs.scarf.sh/gateway/#do-not-track) and [here](https://docs.scarf.sh/package-analytics/#as-a-user-of-a-package-using-scarf-js-how-can-i-opt-out-of-analytics). Additional opt-out instructions for Docker users are available on the [Docker Installation](https://superset.apache.org/docs/installation/installing-superset-using-docker-compose) page.
diff --git a/docs/docs/installation/installing-superset-using-docker-compose.mdx b/docs/docs/installation/installing-superset-using-docker-compose.mdx
index 7cfb76fce1..981fca8147 100644
--- a/docs/docs/installation/installing-superset-using-docker-compose.mdx
+++ b/docs/docs/installation/installing-superset-using-docker-compose.mdx
@@ -96,7 +96,14 @@ You can configure the Docker Compose environment varirables for dev and non-dev
 
 One important variable is `SUPERSET_LOAD_EXAMPLES` which determines whether the `superset_init` container will load example data and visualizations into the database and Superset. These examples are quite helpful for most people, but probably unnecessary for experienced users. The loading process can sometimes take a few minutes and a good amount of CPU, so you may want to disable it on a resource-constrained device.
 
-**Note:** Users often want to connect to other databases from Superset. Currently, the easiest way to do this is to modify the `docker-compose-non-dev.yml` file and add your database as a service that the other services depend on (via `x-superset-depends-on`). Others have attempted to set `network_mode: host` on the Superset services, but these generally break the installation, because the configuration requires use of the Docker Compose DNS resolver for the service names. If you have a  [...]
+
+:::note
+Users often want to connect to other databases from Superset. Currently, the easiest way to do this is to modify the `docker-compose-non-dev.yml` file and add your database as a service that the other services depend on (via `x-superset-depends-on`). Others have attempted to set `network_mode: host` on the Superset services, but these generally break the installation, because the configuration requires use of the Docker Compose DNS resolver for the service names. If you have a good solut [...]
+:::
+
+:::note
+Superset uses [Scarf Gateway](https://about.scarf.sh/scarf-gateway) to collect telmetry data to better understand and support the need for patch versions of Sueprset. Scarf purges PII and provides aggregated statistics. Superset users can easily opt out of analytics in various ways documented [here](https://docs.scarf.sh/gateway/#do-not-track). However, if you wish to opt-out of this in your Docker-based installation, you can simply edit your `docker-compose.yml` or `docker-compose-non-d [...]
+:::
 
 ### 4. Log in to Superset
 
diff --git a/docs/docs/installation/running-on-kubernetes.mdx b/docs/docs/installation/running-on-kubernetes.mdx
index 17b884aeea..2a63de9b46 100644
--- a/docs/docs/installation/running-on-kubernetes.mdx
+++ b/docs/docs/installation/running-on-kubernetes.mdx
@@ -121,6 +121,10 @@ init:
       . {{ .Values.configMountPath }}/superset_init.sh
 ```
 
+:::note
+Superset uses [Scarf Gateway](https://about.scarf.sh/scarf-gateway) to collect telmetry data to better understand and support the need for patch versions of Sueprset. Scarf purges PII and provides aggregated statistics. Superset users can easily opt out of analytics in various ways documented [here](https://docs.scarf.sh/gateway/#do-not-track). However, if you wish to opt-out of this in your Helm-based installation, you can simply edit your `helm/superset/values.yaml` file and remove `ap [...]
+:::
+
 #### Dependencies
 
 Install additional packages and do any other bootstrap configuration in the bootstrap script.