Doc: Update info about collecting user statistics

The options are gone; users can just turn data collection
on or off.

Moved the QDS info into the qtdesignstudio folder and remove
Qt Creator specific information.

Updated screenshots.

Task-number: QTCREATORBUG-31510
Change-Id: Ie9f252b972bd7ee176723afd8a2328b301e65a2e
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
This commit is contained in:
Leena Miettinen
2024-11-06 16:16:32 +01:00
parent 9c2806e73c
commit 429b67fa1d
8 changed files with 100 additions and 109 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

View File

@@ -0,0 +1,38 @@
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page creator-how-to-collect-usage-statistics.html
\previouspage creator-how-tos.html
\ingroup creator-how-to-use
\title Collect usage statistics
When you install \QC with \QOI, you can allow it to collect pseudonymous
information about your system and \QC use. If you decline, the telemetry
plugin is not installed and no usage statistics are collected.
\section1 Principles of data collection
No personal data, such as names, IP addresses, MAC addresses, or project
and path names are collected. However, QUuid objects are used to identify
data records that belong to one user. The objects cannot be converted
back to the actual values from which they were generated.
For more information about Qt privacy policy, see
\l{https://www.qt.io/terms-conditions/privacy-and-security}
{Qt Appendix for Privacy and Security}.
\QC respects the same privacy rules.
\section1 Turn on data collection
To allow the telemetry plugin to collect data, go to \preferences >
\uicontrol Telemetry > \uicontrol {Usage Statistics}, and then select
\uicontrol {Send pseudonymous usage statistics}.
\image qtcreator-preferences-telemetry-usage-statistics.webp {Usage Statistics}
\sa {Installation}
*/

View File

@@ -1,106 +0,0 @@
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page creator-telemetry.html
\if defined(qtdesignstudio)
\previouspage creator-quick-ui-forms.html
\nextpage collecting-usage-statistics.html
\else
\previouspage creator-how-tos.html
\endif
\ingroup creator-how-to-use
\title Manage data collection
\if defined (qtcreator)
When you install \QC as a part of Qt installation, you are asked whether
you allow it to collect pseudonymous information about your system and \QC
use. If you decline, the plugin is not installed and no analytics data is
collected.
If you accept, all collected and transmitted data is fully transparent to
you. You can change the settings for collecting and transmitting data any
time. By default, no data is collected and you have to select a telemetry
mode for data collection to begin.
See \l {Collect usage statistics} for more information about the data
transmitted by the telemetry plugin and \l {Specify telemetry settings}
{specifying telemetry settings}.
\else
To enable the use of the telemetry plugin, you need to select \uicontrol
{Enable Usage Statistics} in the splash screen that appears when you first
launch \QDS. If the splash screen does not appear, you can enable the
telemetry plugin by selecting \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol Utilities > \uicontrol UsageStatistic on Linux and Windows (or
\uicontrol {\QDS} > \uicontrol {About Plugins} > \uicontrol Utilities >
\uicontrol UsageStatistic on \macos).
\image studio-usage-statistics.png "Enabling Usage Statistics"
\endif
\if defined(qtdesignstudio)
See below for more information about the collected data:
\list
\li \l {Collect usage statistics}
\li \l {Collecting User Feedback}
\li \l {Reporting Crashes}
\endlist
\endif
\section1 Principles of data collection
No personal data, such as names, IP addresses, MAC addresses, or project
and path names are collected. However, QUuid objects are used to identify
data records that belong to one user. The objects cannot be converted
back to the actual values from which they were generated.
For more information about Qt privacy policy, select
\l{https://www.qt.io/terms-conditions/#privacy}
{Legal Notice and Privacy Policy}.
\sa {Collect usage statistics}
*/
/*!
\page collecting-usage-statistics.html
\if defined(qtdesignstudio)
\previouspage creator-telemetry.html
\nextpage studio-user-feedback.html
\else
\previouspage creator-how-tos.html
\endif
\ingroup creator-how-to-use
\title Collect usage statistics
The telemetry plugin uses the
\l{https://api.kde.org/frameworks/kuserfeedback/html/index.html}
{KUserFeedback} framework to collect the usage data. The library
has been designed from the user data privacy point of view and
\QC respects the same privacy rules.
The data is transmitted to the backend storage using an encrypted
connection. The storage is located in the same Heroku backend as the
\QOI backend. Physically, data is stored in the Amazon cloud.
\section1 Specify telemetry settings
To determine what data is transmitted to the backend storage:
\list 1
\li Select \preferences > \uicontrol Telemetry
> \uicontrol {Usage Statistics}.
\image qtcreator-telemetry-settings.png "Telemetry settings"
\li In the \uicontrol {Telemetry mode} list, select the mode that
determines what kind of data is collected.
\li In the \uicontrol {Data sources} list, select entries to view
exactly what data is collected. Deselect check boxes for data
that you do not want to transmit to the backend storage.
\endlist
\sa {Manage data collection}
*/

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.9 KiB

View File

@@ -0,0 +1,59 @@
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page studio-telemetry.html
\previouspage creator-quick-ui-forms.html
\nextpage studio-collecting-usage-statistics.html
\title Managing Data Collection
See below for more information about the collected data:
\list
\li \l {Collecting Usage Statistics}
\li \l {Collecting User Feedback}
\li \l {Reporting Crashes}
\endlist
\section1 Principles of Data Collection
No personal data, such as names, IP addresses, MAC addresses, or project
and path names are collected. However, QUuid objects are used to identify
data records that belong to one user. The objects cannot be converted
back to the actual values from which they were generated.
For more information about Qt privacy policy, see
\l{https://www.qt.io/terms-conditions/privacy-and-security}
{Qt Appendix for Privacy and Security}.
\sa {Collecting Usage Statistics}
*/
/*!
\page studio-collecting-usage-statistics.html
\previouspage studio-telemetry.html
\nextpage studio-user-feedback.html
\title Collecting Usage Statistics
The telemetry plugin uses the
\l{https://api.kde.org/frameworks/kuserfeedback/html/index.html}
{KUserFeedback} framework to collect the usage data. The library
has been designed from the user data privacy point of view and
\QC respects the same privacy rules.
The data is transmitted to the backend storage using an encrypted
connection. The storage is located in the same Heroku backend as the
\QOI backend. Physically, data is stored in the Amazon cloud.
\section1 Turning on Telemetry
To determine what data is transmitted to the backend storage, go to
\preferences > \uicontrol Telemetry > \uicontrol {Usage Statistics},
and then select \uicontrol {Enable telemetry}.
\image studio-preferences-telemetry-usage-statistics.webp {Usage Statistics}
\sa {Managing Data Collection}
*/

View File

@@ -23,7 +23,7 @@
Some of the wizard templates create projects that contain UI files.
You should always edit UI files in the \l {2D}
and \l Properties view, to avoid breaking the code.
\li \l{Manage Data Collection}
\li \l{Managing Data Collection}
You can enable \QDS to report crashes automatically. If you enable
the telemetry plugin, you can turn on the pseudonymous user

View File

@@ -230,9 +230,9 @@
\li Extending Component Functionality
\endomit
\li \l{UI Files}
\li \l{Manage Data Collection}
\li \l{Managing Data Collection}
\list
\li \l {Collect Usage Statistics}
\li \l {Collecting Usage Statistics}
\li \l {Collecting User Feedback}
\li \l {Reporting Crashes}
\endlist