From 5bf5cc0d5070abc0a7b131c9b65f5edfa20f14f5 Mon Sep 17 00:00:00 2001 From: Johanna Vanhatapio Date: Thu, 15 Apr 2021 21:17:19 +0300 Subject: Doc: Add info about the user feedback prompt Fixes: QDS-3601 Change-Id: Ie7ceb09f142d233c4335e1445dac1618c8b00211 Reviewed-by: Leena Miettinen --- doc/qtcreator/src/howto/creator-telemetry.qdoc | 76 ++++++++++++++++++--- .../overview/creator-only/creator-advanced.qdoc | 2 +- .../creator-only/creator-help-overview.qdoc | 4 +- doc/qtcreator/src/qtcreator-toc.qdoc | 5 +- .../images/studio-feedback-popup.png | Bin 0 -> 5977 bytes .../src/qtdesignstudio-advanced.qdoc | 5 +- doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc | 7 +- 7 files changed, 82 insertions(+), 17 deletions(-) create mode 100644 doc/qtdesignstudio/images/studio-feedback-popup.png (limited to 'doc') diff --git a/doc/qtcreator/src/howto/creator-telemetry.qdoc b/doc/qtcreator/src/howto/creator-telemetry.qdoc index 761fdd65d1..6b0671e639 100644 --- a/doc/qtcreator/src/howto/creator-telemetry.qdoc +++ b/doc/qtcreator/src/howto/creator-telemetry.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2020 The Qt Company Ltd. +** Copyright (C) 2021 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -27,13 +27,13 @@ \page creator-telemetry.html \if defined(qtdesignstudio) \previouspage creator-editor-external.html - \nextpage studio-help.html \else \previouspage creator-task-lists.html - \nextpage creator-help-overview.html \endif + \nextpage collecting-usage-statistics.html + + \title Managing Data Collection - \title Managing Data Collection Settings \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 @@ -44,6 +44,11 @@ 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 {Collecting Usage Statistics} for more information about the data + transmitted by the telemetry plugin and \l {Specifying 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 @@ -53,6 +58,16 @@ \image studio-usage-statistics.png "Enabling Usage Statistics" \endif + \if defined(qtdesignstudio) + 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 + \endif + \section1 Principles of Data Collection No personal data, such as names, IP addresses, MAC addresses, or project @@ -63,8 +78,18 @@ For more information about Qt privacy policy, select \l{https://www.qt.io/terms-conditions/#privacy} {Legal Notice and Privacy Policy}. +*/ - \section1 Collecting Usage Statistics +/*! + \page collecting-usage-statistics.html + \previouspage creator-telemetry.html + \if defined(qtdesignstudio) + \nextpage collecting-user-feedback.html + \else + \nextpage creator-help-overview.html + \endif + + \title Collecting Usage Statistics The telemetry plugin uses the \l{https://api.kde.org/frameworks/kuserfeedback/html/index.html} @@ -76,7 +101,7 @@ connection. The storage is located in the same Heroku backend as the Qt installer backend. Physically, data is stored in the Amazon cloud. - \section2 Specifying Telemetry Settings + \section1 Specifying Telemetry Settings To determine what data is transmitted to the backend storage: @@ -90,9 +115,42 @@ exactly what data is collected. Deselect check boxes for data that you do not want to transmit to the backend storage. \endlist +*/ - \if defined(qtdesignstudio) - \section1 Reporting Crashes +/*! + \page collecting-user-feedback.html + \previouspage collecting-usage-statistics.html + \nextpage creator-crashpad.html + + \title Collecting User Feedback + + A pop-up survey asking for your feedback will appear for some of the features + after you have been using them for some time. You will be asked to to rate + the usefulness of the feature on a scale of one to five stars. You must rate + the feature with at least one star if you wish to submit your rating. You + are also encouraged to give additional written feedback. After you select + \uicontrol Skip or \uicontrol Submit, the pop-up survey will not appear for + the same feature again. + + \image studio-feedback-popup.png "User feedback pop-up survey for Flow Editor" + + For the pop-up survey to appear, you must enable collecting statistics, and + also allow collecting \uicontrol {4 - Detailed usage statistics} in + \uicontrol Tools > \uicontrol Options > \uicontrol Telemetry > + \uicontrol {Usage Statistics} > \uicontrol {Telemetry mode}. + You can review the submitted user feedback in + \uicontrol Tools > \uicontrol Options > \uicontrol Telemetry > + \uicontrol {Usage Statistics} > \uicontrol {Collected Data} by selecting + \uicontrol {Qt Quick Designer Usage of views and actions} in + \uicontrol {Data sources}. +*/ + +/*! + \page creator-crashpad.html + \previouspage collecting-user-feedback.html + \nextpage studio-help.html + + \title Reporting Crashes You can enable \QDS to report crashes automatically. \QDS uses Google Crashpad to collect crashes and report them to the Sentry backend storage @@ -118,6 +176,4 @@ remove the crash report data. \image studio-crashpad-checkbox.png "Checkbox for enabling crash reporting" - - \endif */ diff --git a/doc/qtcreator/src/overview/creator-only/creator-advanced.qdoc b/doc/qtcreator/src/overview/creator-only/creator-advanced.qdoc index 7f89c0ea81..7da29cd5d7 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-advanced.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-advanced.qdoc @@ -96,7 +96,7 @@ corresponding source code by clicking the error message or by using keyboard shortcuts. - \li \l{Managing Data Collection Settings} + \li \l{Managing Data Collection} If you agreed to pseudonymous data collection during \QC installation, you can turn it on and determine what type diff --git a/doc/qtcreator/src/overview/creator-only/creator-help-overview.qdoc b/doc/qtcreator/src/overview/creator-only/creator-help-overview.qdoc index b808d79e53..79b44ada52 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-help-overview.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-help-overview.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2020 The Qt Company Ltd. +** Copyright (C) 2021 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -31,7 +31,7 @@ /*! \page creator-help-overview.html - \previouspage creator-telemetry.html + \previouspage collecting-usage-statistics.html \nextpage creator-help.html \title Getting Help diff --git a/doc/qtcreator/src/qtcreator-toc.qdoc b/doc/qtcreator/src/qtcreator-toc.qdoc index b0be2343dc..2668c43b0b 100644 --- a/doc/qtcreator/src/qtcreator-toc.qdoc +++ b/doc/qtcreator/src/qtcreator-toc.qdoc @@ -308,7 +308,10 @@ \li \l{Keyboard Shortcuts} \li \l{Using External Tools} \li \l{Showing Task List Files in Issues Pane} - \li \l{Managing Data Collection Settings} + \li \l{Managing Data Collection} + \list + \li \l {Collecting Usage Statistics} + \endlist \endlist \li \l{Getting Help} \list diff --git a/doc/qtdesignstudio/images/studio-feedback-popup.png b/doc/qtdesignstudio/images/studio-feedback-popup.png new file mode 100644 index 0000000000..5a6d38bc05 Binary files /dev/null and b/doc/qtdesignstudio/images/studio-feedback-popup.png differ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-advanced.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-advanced.qdoc index f48f28568a..4a5cedecaf 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-advanced.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-advanced.qdoc @@ -85,7 +85,7 @@ editor for your system, and the \c sort tool are preconfigured for use. You can change their default configurations and configure new tools. - \li \l{Managing Data Collection Settings} + \li \l{Managing Data Collection} \if defined (qtcreator) You can enable \QC to report crashes automatically. If you agreed to @@ -96,7 +96,8 @@ You can enable \QDS to report crashes automatically. If you enable the telemetry plugin, you can turn on the pseudonymous user statistics collection and determine what type of data is collected - and transmitted to the backend storage. + and transmitted to the backend storage. You can also modify + settings for collecting user feedback. \endif \endlist */ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc index 20f600e79e..fa6da97cc9 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc @@ -210,7 +210,12 @@ \li \l{Profiling QML Applications} \endlist \li \l{Using External Tools} - \li \l{Managing Data Collection Settings} + \li \l{Managing Data Collection} + \list + \li \l {Collecting Usage Statistics} + \li \l {Collecting User Feedback} + \li \l {Reporting Crashes} + \endlist \endlist \li \l{Help} \list -- cgit v1.2.3