From 5bf5cc0d5070abc0a7b131c9b65f5edfa20f14f5 Mon Sep 17 00:00:00 2001 From: Johanna Vanhatapio Date: Thu, 15 Apr 2021 21:17:19 +0300 Subject: [PATCH] Doc: Add info about the user feedback prompt Fixes: QDS-3601 Change-Id: Ie7ceb09f142d233c4335e1445dac1618c8b00211 Reviewed-by: Leena Miettinen --- .../src/howto/creator-telemetry.qdoc | 76 +++++++++++++++--- .../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 +- .../src/qtdesignstudio-toc.qdoc | 7 +- 7 files changed, 82 insertions(+), 17 deletions(-) create mode 100644 doc/qtdesignstudio/images/studio-feedback-popup.png diff --git a/doc/qtcreator/src/howto/creator-telemetry.qdoc b/doc/qtcreator/src/howto/creator-telemetry.qdoc index 761fdd65d10..6b0671e6393 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 7f89c0ea816..7da29cd5d77 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 b808d79e537..79b44ada523 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 b0be2343dcf..2668c43b0b7 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 0000000000000000000000000000000000000000..5a6d38bc050649a1b4a1bd2db28a0be24b99a4ce GIT binary patch literal 5977 zcmeAS@N?(olHy`uVBq!ia0y~yUljy?ghrUAy-D`Sa|p*EFl=C?>aLZ#}p6-utMisJ(mlZr!@Iy1IJl zwfFDezn?N?%J=Wz4Gj&~u3g)5?)jWKbCQ#j_dfrA?fv(lprAR|-WL}aS08(xot+)E z_g+s=&%O6QijO_tdhh$vrAu2{T4wJ(=jG+)U+ z+sscZe{=QzN4|F-zG~)u`=D9VRcP1hzwzC#E9w_C#a@am4bHi&>9zdEvfwFx8-15+ z%uSl@7ie|VZ0@3xu3RhEmm;@Ix-MyMdnsaH_G$(L0|P_igusLe(A2{#P z?ByE%AI}C)S^ndh=BePC&mvDX_f>X%5=q`36Q;_(P-B;1O;3-|Y85Ae!U+MA-~a!Q zdTppbYtixVUS^?BLS8*ld5|=7{@mli{td^2{p-r){B0TK{B3{Ue0d|d`P#yoX+bVi zJh&D3x0Za4wsvr1z2G?2OZ9AEk}AWrZT41DGLg3oIJM6kzpo5s*sKxg_dsU7Q0eV3 z6@UN96L0hEy%L=lEzx)Ffk?uoZLXbsmo_fgGfyWru^eN0z z*rIWN$D$>ZQti5%5}5lePDe_*{SOM7vN+;-)l8-b_qk)e12}TC%=3><@DlH7eRAh~ z+q{g=k2BJ?Z#UZQ$s<%C-+F(3pKYp6)Sj;&&s}kOv1d{H6{Z9!mbMFP{<%D0aIEM* zox!=s(_qgD@5<*I>q}Q~Xec_pca3|QxlXwAn78h^zS^26KmNYF8T?HrWC8=fb#Ujx zw2isCix0ljoVfg%=DLsmbC{ogxU%a)<4ZH4iA%j^{XI2hj_99rQ

LYtDMLW1i`k zqapj}X&s%!?_aqhazWeV`A;SkRCt}Za_#Do_dcD4+R(toQSzqtxYPFg1#IU2iYI3;|I@qj&(+`~9s(O=jD%wE-&_8!dj6uF&+obW z9KDieR5Ed%?bqpZH{UK4W?S^(#H2>;{~CPLCJH#kG(50+|352r!`TaBEAM)R&MmQ9 zxx3{D&*Z0XHr_tA@p`l4lb!m%9s4&t{$slQfPZ1H-=W`Mr+jU=@V6CoN;EivJ>tCuZzm&9B?tA{~Mva3}n`*BzykuGQ=wSAm$@ZCH zbK-vsGtZqN_U7$lo3DkIrOnyy33(6ZBy~Oee@gS2+&RrJ|)&Diztbt`LGrC;q;X5PO~L*2aW({|sy?)v9(o|a#q-v9nizRK&i{hQfOQr7*x-}m6&-QfRr z%RlX1xtCi`enu7_o03(Ff?`l>^7lE>xij<^FSKMk|Mvk?m5K%9#GQ&J8KVEGY@-$-YmN~EbH|CyQMF$mr#wiD z@{e^}|H#Vv$J0%ktD;x9++x!?uAXbTVCVW*vnmvhy|)QH+OBfg@#i%&h0uL#dUsEp z-^`}HD5Zg?H1*B-*P74$bl+axSYg9z5#h7XXWxc+)(NY4yiTvY9Goor{%`S=2_H`e zGp}8~Zn0uw?VkstLfW3Hla{B6o6ntm=!Qwjr;{-^gYP+A&UV5_`aJxm0 zZ&*5FR8>}J*KeL@G;Pa-{k@@CyfbUwU5(x2xyndGcloZz-n&=XRiCPIxbrP&b#wE> zt-VV3Ii-A8-}upbWbU46A0n>jW<6K+e3&bh6}~iNf7taoOq;ju&GvX!e@;_AzM#*N}ar=pc}y)LQ-ZI>&l408{(5Pm&a*2e>y~RQUy`M8 z`AoL#@-wUtZe6_^JSBLE@4Q8CmvqFV4Pp2HR_b=hpi~Qhlb&ATn z-|{;qUB4*qfAslgiL>QW>gQ|Ic77G%D}DHGrUZ}O>7L$rjpZ5dvKuzcTjLxX`+VPK z$NcrTQhu-7w?=mE@;;5_WuXh_X(=z?wdLaOu+lRtFF5`yIJA8CkAx2l%|G)@RMhqq zGF|@`^;CM2m(7Nj15e$jPW!UtgXQvoS)3I`o=Z!&pMG*Q*tE~&Z>jB7MxK<~p1@xT ztgpD9F89}5?x!nRu<1*cd|BV#ORdRs7f#7se`QY7g>CB--$>toH%I>Em2G=tndQ#! zNR)Y-8n<@Q#cw*Bwq}>+$iG+BeU{vr%FUph=V!j7IyP1$-OusH(p;VECBGLOJZAfL zb%V-jzB#wbHdns;{Ji~r;$tDTHIVcvL8gKQj zDo*0|iB&=WjQsk2V z|NW1qa0n;8h%TA9=ZDU+%U{}p_8MP*aDgMq-*w)c8^MA{=5^UvZd|U^VJli$l;rO! zP_6ap$&quPL90|#_?~RjNbxP&%>Xj?9YY#R^6gdY>^9)^ia<5)? zXwoS~4VSg7YfuL)d#KK6VU!Htq8Dn7^v(1yA2Z71!Hb`OLX$*%8swf0L?T zzSU~84XwAhI%~-kBj45=kA>}zH6GDO-5)OT!}3Kk+xcUb&&-vx72PjR32Z-X@mBuZ ztjS8EzorQ%>&-0w)-F|}BffKwU+~Lfx0U~{pWOd>@&36F=DcqCG3hY(;f>3WtX2M? zTjL&N`at4T+4o-6#8lAGB1_Ri0x`ZpxMO_`qNJ?)DB6a~k3lNy#D zjCpXu(Um!$Q}frO*{@`(vm931h8cW2Eq~Hy&Fblo+RC10o%`)J!S(i&cPzWF-dXM6 zl+@X~y=7nn3eOPjbcgxCA{jy#DBG;_cw;shuW< z6GgdCmzgrnnIm((f6J2#oF_~(w4Z)2)pyV;!n)xcPr~29^*^&lKfHI za4YE{!`Z;x%)Yn^n-7O}E|+tQT*{GDJd3%L$3{tXLCmge0{#W;d~jUI{K1J1Ya{u6ns|-P>p7Y%lEjgDwBQY`9UfrR3`~ zW|PZ_T-py3KgG*he7{nMdXayMzBnIC(XE+>VpDI; z7ku<*M;=?bCBw|L+q1 zoF!4>pLX=m!NpZC*@b?5pEA*5`LfJy|7Le{-&^WC`RfU1sj>sR&8LYN?3Ox{>b$Ou zEjU^>{GCd);kxaY-Q2Gl-t{M z$Y9p$GIc@^U5W8p+_Gzb>;heP8U60|K?r)A!hd5NsXJ>Z62(-dU_7m(<#E7$ zC^>I8XTg~}-u9j6_AdWb+{eDko&AY>LeHb{E>(FU{w4dlg7nVIOf%7&U~Lfb=f}4z z_0L_-?X|3_)?%{SxLnEK_svQUP#JgU$h@vUsmuL>WV#X=I>eZGPw)GmDgB7WPEx^} z^;IM9p=0+%Z)m%+Q}(A^85^$yGJ`mdU>eaZnNV znWGUZW+EDUB=OOD_|f%VGA-%??F#{i|lROkO%w2@h+Plo2FFGyr{|{ zVLor}a+b)1S<87Av^2?DNxp3nd2##w!V}6(3X>(5rtmb$rE{F-Tg0ni(RBLc1A~K; z-yKnj(JX&8PxiG^65mOmc~25_grijRmR0f23tBUK?#UVdxKxEty=`H>qb<>H(`$8b z!p17qFB^mAwv-DPOMdI(Q_Cr6OIh#2w#WDFsn<$bd_FB~{yD}su9Vsb*xLK69?o>1 zmTWKH{Ged!gEE1=UXc!6^9rNN*S;!)qZ8R@oU4~G=t<~NO4k)Cp=#T3U zeku|9uyj>Ys3)Jsu9m!6RgCkzHrD6tpKhtNN7monW%r|#pHps}xEg#WZmZbGC!Wdd zv#)Pj=3GDHq+iQcA^GPDttuCoEBc&*lV%%w-|@ch{o#t@lf(rc%n#y@gosWTp3lP& zIOTJKq>k7mZMT#_&mAWiRyQ+rMP1~&!c*ARRBOZXrg+)SB_2|)@0eyC{?ci)t3_nT z$2&G(nKcSN?SB8EjQtr)&2i6^eEO{b?1F{H~4(Z^@o}rjoh8=@5I+XKlJ*; zmEQ1!+#j#>iXS{1Z2p1GX6lj;?gEmzU*~_GF4bl~-Sma^MtOyMS>7KcE4vJvesGHX z&~r-ukbaBlq4rr^Ll}=h)A0)wMZYc|wHY_pP*Pf=;$pa%L7co_B9(K740m zHutOp^9)1}i@J0fW-L3WaZOdgAd;zJt!u^y3qC~_n-b2h zX3^<(iYGR0=Zi3o;S4*Qd|Amfn8E1B46tzTzT#DOgmOnc`?Cel5^C7L$9?^OBG{m}o>S|2!S*x1 zKV0b*Kdk-XO7HbUXM@e{HU}R!<6&|XaAiMjd5%NlP~*$}X5B&pEQ@!4FVmj!zC1ceZ1IbI zd1YO&)z|d%JYh0yjRrQ8gT8K<;54DO`B03lrd-I2-}aZ?mR?9H_n!RD>B7&f_E}E+ zPv4sd7f1Miw7JT3{8Py3{c+z!4yc?DY7k;ru=L(rO=srHH5Hp{PCwQxz4d$7mnqY- z^b}lfzWFv~uY?byc1nSxL(z{DqPLb6`-hsR`ujR@uWb>y%;zt8%JgT$F-5_j!dCA0 zDmG>8?VYGoy~@z-2XAGVl!K@4^2(KazLfdTP1>W%lX9_ACB1XPp0DE7-6sVmad$pn zc}(KrO$SwnGY;oMR?fB!W!Dl}quDH#v6jPIdgpDUv74X0FV${n{Y(Yj5$F5U*clmK&BwJ$~wQvfj%5 z{g&?=moqHmta~!q_~<;VFMs#d86BN>YQypy!EaVRJ~%JQKlMg%wB*!TVcD0PZI8~2 zGT!6;Z<*MM*G2WU73m=8 zy4oGJn6ETHX^#Iyf5UUjPb`;s9{eP@=QEPBa^Kp5