diff --git a/doc/qtcreator/images/qtcreator-telemetry-settings.png b/doc/qtcreator/images/qtcreator-telemetry-settings.png new file mode 100644 index 00000000000..aac2db8240a Binary files /dev/null and b/doc/qtcreator/images/qtcreator-telemetry-settings.png differ diff --git a/doc/qtcreator/src/howto/creator-only/creator-task-lists.qdoc b/doc/qtcreator/src/howto/creator-only/creator-task-lists.qdoc index 7c007f0e435..9ef66cc6889 100644 --- a/doc/qtcreator/src/howto/creator-only/creator-task-lists.qdoc +++ b/doc/qtcreator/src/howto/creator-only/creator-task-lists.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -33,7 +33,7 @@ \contentspage index.html \previouspage creator-editor-external.html \page creator-task-lists.html - \nextpage creator-help-overview.html + \nextpage creator-telemetry.html \title Showing Task List Files in Issues Pane diff --git a/doc/qtcreator/src/howto/creator-only/creator-telemetry.qdoc b/doc/qtcreator/src/howto/creator-only/creator-telemetry.qdoc new file mode 100644 index 00000000000..a9cc4359d19 --- /dev/null +++ b/doc/qtcreator/src/howto/creator-only/creator-telemetry.qdoc @@ -0,0 +1,79 @@ +/**************************************************************************** +** +** Copyright (C) 2020 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the Qt Creator documentation. +** +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** +****************************************************************************/ + +/*! + \contentspage index.html + \previouspage creator-task-lists.html + \page creator-telemetry.html + \nextpage creator-help-overview.html + + \title Managing Data Collection Settings + + 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. + + \section1 Principles of Data Collection + + 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. + + 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. + + The data is transmitted to the backend storage using an encrypted + connection. The storage is located in the same Heroku backend as the + Qt installer backend. Physically, data is stored in the Amazon cloud. + + \section1 Specifying Telemetry Settings + + To determine what data is transmitted to the backend storage: + + \list 1 + \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Telemetry + > \uicontrol {Usage Statistics}. + \image qtcreator-telemetry-settings.png + \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 + + For more information about Qt privacy policy, select + \l{https://www.qt.io/terms-conditions/#privacy} + {Legal Notice and Privacy Policy}. +*/ diff --git a/doc/qtcreator/src/overview/creator-only/creator-advanced.qdoc b/doc/qtcreator/src/overview/creator-only/creator-advanced.qdoc index 27db06538dd..e31f6199ff9 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-advanced.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-advanced.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -97,6 +97,12 @@ corresponding source code by clicking the error message or by using keyboard shortcuts. + \li \l{Managing Data Collection Settings} + + If you agreed to pseudonymous data collection during \QC + installation, you can turn it on and determine what type + of data is collected and transmitted to the backend storage. + \endlist */ 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 fd16ed3e9fa..8798219a011 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) 2018 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -32,7 +32,7 @@ /*! \contentspage index.html \page creator-help-overview.html - \previouspage creator-task-lists.html + \previouspage creator-telemetry.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 31d99a99ab8..a01ad1cd34f 100644 --- a/doc/qtcreator/src/qtcreator-toc.qdoc +++ b/doc/qtcreator/src/qtcreator-toc.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2019 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -222,6 +222,7 @@ \li \l{Keyboard Shortcuts} \li \l{Using External Tools} \li \l{Showing Task List Files in Issues Pane} + \li \l{Managing Data Collection Settings} \endlist \li \l{Getting Help} \list