From c4c5a825edae5555a124412e9c22c7bbeb4496ef Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABtan=20Trellu?= Date: Fri, 17 Nov 2023 09:38:59 -0500 Subject: [PATCH] [doc] Add information about telemetry --- README.md | 16 +++++++-------- docs/{ => images}/screenshot_1.png | Bin docs/{ => images}/screenshot_2.png | Bin docs/{ => images}/screenshot_3.png | Bin docs/{ => images}/screenshot_4.png | Bin docs/{ => images}/screenshot_5.png | Bin docs/{ => images}/screenshot_6.png | Bin docs/{ => images}/screenshot_7.png | Bin docs/{ => images}/screenshot_8.png | Bin docs/telemetry.md | 31 +++++++++++++++++++++++++++++ tui/locales/en-us/telemetry.sh | 4 +++- tui/locales/fr-fr/telemetry.sh | 4 +++- 12 files changed, 45 insertions(+), 10 deletions(-) rename docs/{ => images}/screenshot_1.png (100%) rename docs/{ => images}/screenshot_2.png (100%) rename docs/{ => images}/screenshot_3.png (100%) rename docs/{ => images}/screenshot_4.png (100%) rename docs/{ => images}/screenshot_5.png (100%) rename docs/{ => images}/screenshot_6.png (100%) rename docs/{ => images}/screenshot_7.png (100%) rename docs/{ => images}/screenshot_8.png (100%) create mode 100644 docs/telemetry.md diff --git a/README.md b/README.md index 29d124dc..2289e63a 100644 --- a/README.md +++ b/README.md @@ -14,18 +14,18 @@ Then follow the instructions display on screen. ## Screenshots -![Screenshot 1](docs/screenshot_1.png) +![Screenshot 1](docs/images/screenshot_1.png) -![Screenshot 2](docs/screenshot_2.png) +![Screenshot 2](docs/images/screenshot_2.png) -![Screenshot 3](docs/screenshot_3.png) +![Screenshot 3](docs/images/screenshot_3.png) -![Screenshot 4](docs/screenshot_4.png) +![Screenshot 4](docs/images/screenshot_4.png) -![Screenshot 5](docs/screenshot_5.png) +![Screenshot 5](docs/images/screenshot_5.png) -![Screenshot 6](docs/screenshot_6.png) +![Screenshot 6](docs/images/screenshot_6.png) -![Screenshot 7](docs/screenshot_7.png) +![Screenshot 7](docs/images/screenshot_7.png) -![Screenshot 8](docs/screenshot_8.png) +![Screenshot 8](docs/images/screenshot_8.png) diff --git a/docs/screenshot_1.png b/docs/images/screenshot_1.png similarity index 100% rename from docs/screenshot_1.png rename to docs/images/screenshot_1.png diff --git a/docs/screenshot_2.png b/docs/images/screenshot_2.png similarity index 100% rename from docs/screenshot_2.png rename to docs/images/screenshot_2.png diff --git a/docs/screenshot_3.png b/docs/images/screenshot_3.png similarity index 100% rename from docs/screenshot_3.png rename to docs/images/screenshot_3.png diff --git a/docs/screenshot_4.png b/docs/images/screenshot_4.png similarity index 100% rename from docs/screenshot_4.png rename to docs/images/screenshot_4.png diff --git a/docs/screenshot_5.png b/docs/images/screenshot_5.png similarity index 100% rename from docs/screenshot_5.png rename to docs/images/screenshot_5.png diff --git a/docs/screenshot_6.png b/docs/images/screenshot_6.png similarity index 100% rename from docs/screenshot_6.png rename to docs/images/screenshot_6.png diff --git a/docs/screenshot_7.png b/docs/images/screenshot_7.png similarity index 100% rename from docs/screenshot_7.png rename to docs/images/screenshot_7.png diff --git a/docs/screenshot_8.png b/docs/images/screenshot_8.png similarity index 100% rename from docs/screenshot_8.png rename to docs/images/screenshot_8.png diff --git a/docs/telemetry.md b/docs/telemetry.md new file mode 100644 index 00000000..8ca32013 --- /dev/null +++ b/docs/telemetry.md @@ -0,0 +1,31 @@ +# Open Voice OS installer telemetry + +One of the many ways to improve a software is to know how the users utilize it and to get this information some data must be shared from the user to the developpers. + +The installer collects anonymous data and sends it to Open Voice OS servers to help improve Open Voice OS none of them be used for commercial purpose. + +**The installer will ask you if you want to share or not the data.** + +Below is a list of the collected data *(please have a look to the [Ansible tempalte](https://github.com/OpenVoiceOS/ovos-installer/blob/main/ansible/roles/ovos_installer/templates/telemetry.json.j2) used ti publish the data)*. + +| Data | Description | +| ---------------- | ----------- | +| `architecture` | CPU architecture where OVOS was installed | +| `channel` | `stable` or `development` version of OVOS | +| `container` | OVOS installed into containers | +| `country` | Country where OVOS has been installed | +| `cpu_capable` | Is the CPU supports AVX or SIMD instructions | +| `display_server` | Is X or Wayland are used as display server | +| `gui_feature` | GUI enabled during the installation | +| `installed_at` | Date when OVOS has been installed | +| `os_kernel` | Kernel version of the host where OVOS is running | +| `os_name` | OS name of the host where OVOS is running | +| `os_type` | OS type of the host where OVOS is running | +| `os_version` | OS version of the host where OVOS is running | +| `profile` | Which profile has been used during the OVOS installation | +| `python_version` | What Python version was running on the host | +| `raspberry_pi` | Does OVOS has been installed on Raspberry Pi | +| `skills_feature` | Default OVOS's skills enabled during the installation | +| `sound_server` | What PulseAudio or PipeWire used | +| `tuning_enabled` | Did the Rasperry Pi tuning feature wsas used | +| `venv` | OVOS installed into a Python virtual environment | diff --git a/tui/locales/en-us/telemetry.sh b/tui/locales/en-us/telemetry.sh index 360353e2..d3a0dc9b 100644 --- a/tui/locales/en-us/telemetry.sh +++ b/tui/locales/en-us/telemetry.sh @@ -7,7 +7,9 @@ Your telemetry data includes essential insights into how the software functions The information gathered helps us identify potential issues, optimize features, and ensure a smoother, more efficient user experience for everyone. -Do you accept to share anonymous telemetry data with us? +For more information about collected data please visit: https://github.com/OpenVoiceOS/ovos-installer/tree/main/docs/telemetry.md + +Do you accept to share anonymous data with us? " TITLE="Open Voice OS Installation - Telemetry" diff --git a/tui/locales/fr-fr/telemetry.sh b/tui/locales/fr-fr/telemetry.sh index 527307bf..d3fc1e23 100644 --- a/tui/locales/fr-fr/telemetry.sh +++ b/tui/locales/fr-fr/telemetry.sh @@ -7,7 +7,9 @@ Vos données de télémétrie comprennent des informations essentielles sur le f Les informations recueillies nous aident à identifier les problèmes potentiels, à optimiser les fonctionnalités et à garantir une expérience utilisateur plus fluide et plus efficace pour chacun. -Acceptez-vous de partager avec nous des données de télémétrie anonymes? +Pour de plus amples informations au sujet des données collectées, veuillez visiter: https://github.com/OpenVoiceOS/ovos-installer/tree/main/docs/telemetry.md + +Acceptez-vous de partager avec nous des données anonymes? " TITLE="Open Voice OS Installation - Télémétrie"