This forum is a discussion about improving the "Share telemetry data with Mozilla to help improve Firefox" article. If you'd like to participate, please register.

If you need help with Firefox, please ask a question.

[Done] Getting this ready to publish

  • 13 Replies
  • Last reply by Michael Verdi
  1. Michael Verdi 1755 posts
    Report Abuse

    Laurence Mandel contacted me via email with a draft of an article about Telemetry. I took that and created this article. I didn't name it Telemetry because the feature isn't called that in the UI and that word isn't used anywhere except in our privacy policy. I also removed references to Nightly, Aurora and Beta since we're not documenting them.

    I think the following changes will make this article ready for approval:

    • The introduction can be made a little friendlier
    • The introduction should also explain that we often refer to the feature that "submits performance data" as telemetry instead of assuming that the reader knows what telemetry refers to.
    • We should reference the info bar that is shown to people after they upgrade to a version of Firefox as this is probably the main way people will opt-in.
    • We should link to the telemetry section of the privacy policy - http://www.mozilla.org/en-US/legal/privacy/firefox.html#telemetry

    Ideally, once published, the info bar with the opt-in should link to this article instead of the privacy policy.

    Laurence Mandel contacted me via email with a draft of an article about Telemetry. I took that and created this article. I didn't name it Telemetry because the feature isn't called that in the UI and that word isn't used anywhere except in our privacy policy. I also removed references to Nightly, Aurora and Beta since we're not documenting them. I think the following changes will make this article ready for approval: * The introduction can be made a little friendlier * The introduction should also explain that we often refer to the feature that "submits performance data" as telemetry instead of assuming that the reader knows what telemetry refers to. *We should reference the info bar that is shown to people after they upgrade to a version of Firefox as this is probably the main way people will opt-in. *We should link to the telemetry section of the privacy policy - http://www.mozilla.org/en-US/legal/privacy/firefox.html#telemetry Ideally, once published, the info bar with the opt-in should link to this article instead of the privacy policy.
  2. lmandel 0 posts
    Report Abuse

    Thanks for helping to get the ball rolling on this Michael.

    I included reference to the various channels as Telemetry is to be an opt-out solution on Nightly and Aurora and an opt-in solution on Beta and Release. Does SUMO restrict documentation to Firefox releases?

    I agree with the rest of your points. My intro certainly needs work as I put that one together in about 5 minutes. I'm happy to help push this along if you need me to.

    Thanks for helping to get the ball rolling on this Michael. I included reference to the various channels as Telemetry is to be an opt-out solution on Nightly and Aurora and an opt-in solution on Beta and Release. Does SUMO restrict documentation to Firefox releases? I agree with the rest of your points. My intro certainly needs work as I put that one together in about 5 minutes. I'm happy to help push this along if you need me to.
  3. sidstamm 0 posts
    Report Abuse

    I agree with Michael's direction too. I had a whack at the article, but it still needs more work.

    https://support.mozilla.org/en-US/kb/how-can-i-help-submitting-performace-data/revision/21319

    I agree with Michael's direction too. I had a whack at the article, but it still needs more work. https://support.mozilla.org/en-US/kb/how-can-i-help-submitting-performace-data/revision/21319
  4. John99 3665 posts
    Report Abuse

    Why not also try to promote the potential benefits. We know for instance one reason for the development and introduction of telemetry was the hangs that were getting missed. So consider adding something like.

    This data allows us to monitor how fast Firefox starts up, and whether it encounters problems where browsing slows down or hangs. By monitoring this sort of information we are able to spot emerging problems and look at areas of Firefox's performance that need improvement.

    You could also mention an add-on is available from the developers that makes the info available for the user to see in a graphical format. Some users may be able to make use of that info, others may find it reassuring that they have the ability themselves to monitor the info that telemetry is collecting.

    Why not also try to promote the potential benefits. We know for instance one reason for the development and introduction of telemetry was the hangs that were getting missed. So consider adding something like. ''This data allows us to monitor how fast Firefox starts up, and whether it encounters problems where browsing slows down or hangs. By monitoring this sort of information we are able to spot emerging problems and look at areas of Firefox's performance that need improvement.'' You could also mention an [https://addons.mozilla.org/en-US/firefox/addon/abouttelemetry/ add-on] is available from the developers that makes the info available for the user to see in a graphical format. Some users may be able to make use of that info, others may find it reassuring that they have the ability themselves to monitor the info that telemetry is collecting.
  5. Michael Verdi 1755 posts
    Report Abuse

    mandel said

    I included reference to the various channels as Telemetry is to be an opt-out solution on Nightly and Aurora and an opt-in solution on Beta and Release. Does SUMO restrict documentation to Firefox releases?

    Yes, we sort of do. Basically we document the current release but as part of being ready we get those documents together during the Aurora and Beta phase and finalize them about 4 weeks out from the release. So we have some beta things out but they are only in English and are really just there to be ready for the release.

    ''mandel [[#post-4965|said]]'' <blockquote> I included reference to the various channels as Telemetry is to be an opt-out solution on Nightly and Aurora and an opt-in solution on Beta and Release. Does SUMO restrict documentation to Firefox releases? </blockquote> Yes, we sort of do. Basically we document the current release but as part of being ready we get those documents together during the Aurora and Beta phase and finalize them about 4 weeks out from the release. So we have some beta things out but they are only in English and are really just there to be ready for the release.
  6. Michael Verdi 1755 posts
    Report Abuse

    Hey guys, I made a few style changes and added Windows screenshots. The article is live - let me know what you think or if there are things that need to be changed.

    John, I didn't add the info about the add-on yet. I'd like to wait and see about that. It may be beyond the scope for a KB article.

    Hey guys, I made a few style changes and added Windows screenshots. The article is live - let me know what you think or if there are things that need to be changed. John, I didn't add the info about the add-on yet. I'd like to wait and see about that. It may be beyond the scope for a KB article.
  7. lmandel 0 posts
    Report Abuse

    Verdi said

    Hey guys, I made a few style changes and added Windows screenshots. The article is live - let me know what you think or if there are things that need to be changed.

    I don't see the screenshots when viewing the article. Should those be live?

    ''Verdi [[#post-5008|said]]'' <blockquote> Hey guys, I made a few style changes and added Windows screenshots. The article is live - let me know what you think or if there are things that need to be changed. </blockquote> I don't see the screenshots when viewing the article. Should those be live?
  8. lmandel 0 posts
    Report Abuse

    mandel said

    Verdi said
    Hey guys, I made a few style changes and added Windows screenshots. The article is live - let me know what you think or if there are things that need to be changed.

    I don't see the screenshots when viewing the article. Should those be live?

    OK. I see that the images only show if I browse to the page with a Windows box. I think the bit about being shown a message without having the message doesn't read well unless the screenshot is there. I have added the notification text for Mac. Can we get screenshots for Mac and Linux posted as well?

    ''mandel [[#post-5009|said]]'' <blockquote> ''Verdi [[#post-5008|said]]'' <blockquote> Hey guys, I made a few style changes and added Windows screenshots. The article is live - let me know what you think or if there are things that need to be changed. </blockquote> I don't see the screenshots when viewing the article. Should those be live? </blockquote> OK. I see that the images only show if I browse to the page with a Windows box. I think the bit about being shown a message without having the message doesn't read well unless the screenshot is there. I have added the notification text for Mac. Can we get screenshots for Mac and Linux posted as well?
  9. lmandel 0 posts
    Report Abuse

    When I view this article on Android I unexpectedly see the Windows screenshots. How can we replace the Windows info with mobile specific info?

    When I view this article on Android I unexpectedly see the Windows screenshots. How can we replace the Windows info with mobile specific info?
  10. Michael Verdi 1755 posts
    Report Abuse

    mandel said

    When I view this article on Android I unexpectedly see the Windows screenshots. How can we replace the Windows info with mobile specific info?

    We'll have to make a mobile specific article for this. Actually we'll need to make one when this hits native UI. For now we can add a section to the tablet article (Michelle may be working on that) - Getting started with the Firefox for Android tablet browser.

    ''mandel [[#post-5011|said]]'' <blockquote> When I view this article on Android I unexpectedly see the Windows screenshots. How can we replace the Windows info with mobile specific info? </blockquote> We'll have to make a mobile specific article for this. Actually we'll need to make one when this hits native UI. For now we can add a section to the tablet article (Michelle may be working on that) - [[Getting started with the Firefox for Android tablet browser]].
  11. Michael Verdi 1755 posts
    Report Abuse

    And why you see windows instructions when viewing with Android is because you are looking at a desktop article. If you switch to mobile articles (on Android, at the bottom of a help article choose "Firefox for Mobile" under other products) you'll see articles about mobile topics with Android screenshots.

    And why you see windows instructions when viewing with Android is because you are looking at a desktop article. If you switch to mobile articles (on Android, at the bottom of a help article choose "Firefox for Mobile" under other products) you'll see articles about mobile topics with Android screenshots.
  12. lmandel 0 posts
    Report Abuse

    Verdi said

    mandel said
    When I view this article on Android I unexpectedly see the Windows screenshots. How can we replace the Windows info with mobile specific info?

    We'll have to make a mobile specific article for this. Actually we'll need to make one when this hits native UI. For now we can add a section to the tablet article (Michelle may be working on that) - Getting started with the Firefox for Android tablet browser.

    I haven't looked at Telemetry on tablets yet. Probably something that should be done soon. For mobile, the content will largely be the same as this article but include the navigation steps specific for mobile. I can create the article and update the opt-in/out steps if you can point me to where I can create a new article.

    ''Verdi [[#post-5013|said]]'' <blockquote> ''mandel [[#post-5011|said]]'' <blockquote> When I view this article on Android I unexpectedly see the Windows screenshots. How can we replace the Windows info with mobile specific info? </blockquote> We'll have to make a mobile specific article for this. Actually we'll need to make one when this hits native UI. For now we can add a section to the tablet article (Michelle may be working on that) - [[Getting started with the Firefox for Android tablet browser]]. </blockquote> I haven't looked at Telemetry on tablets yet. Probably something that should be done soon. For mobile, the content will largely be the same as this article but include the navigation steps specific for mobile. I can create the article and update the opt-in/out steps if you can point me to where I can create a new article.
  13. lmandel 0 posts
    Report Abuse

    Verdi said

    And why you see windows instructions when viewing with Android is because you are looking at a desktop article. If you switch to mobile articles (on Android, at the bottom of a help article choose "Firefox for Mobile" under other products) you'll see articles about mobile topics with Android screenshots.

    Given that there are mobile/android selectors I would have expected not to see any of the Windows specific content on the page. I'm curious as to why the Windows content displays while the Mac and Linux content is hidden. Is that a design decision of the selectors?

    ''Verdi [[#post-5014|said]]'' <blockquote> And why you see windows instructions when viewing with Android is because you are looking at a desktop article. If you switch to mobile articles (on Android, at the bottom of a help article choose "Firefox for Mobile" under other products) you'll see articles about mobile topics with Android screenshots. </blockquote> Given that there are mobile/android selectors I would have expected not to see any of the Windows specific content on the page. I'm curious as to why the Windows content displays while the Mac and Linux content is hidden. Is that a design decision of the selectors?
  14. Michael Verdi 1755 posts
    Report Abuse

    Sorry for taking so long to get back to you...

    The design of the system is to mainly be invisible to the user. The selector is mostly for authors and contributors. So we automatically detect your platform and Firefox version and then show you the appropriate instructions. Since mobile and desktop are so different and the vast majority of desktop articles aren't even applicable to mobile we thought it best to default to showing Windows instructions when you are looking at a desktop article with your mobile device (<90% of our users use Windows). Also, if you look at a mobile article from your desktop we of course show you the mobile instructions. If we didn't do this and you were trying to get help for your desktop while using a mobile device you'd arrive at an article and see that it was empty (or just had an introduction). Then you'd have to discover the selector in the sidebar and set it to the platform and version you wanted.

    A new article can be created here - https://support.mozilla.org/en-US/kb/new Since telemetry is only available in Aurora you should include this template https://support.mozilla.org/en-US/kb/templateapplytofx Also, be sure to talk to Michelle, the mobile support coordinator.

    This article is a brief intro to our KB and has the rest of the KB documentation linked at the bottom - Improve the Knowledge Base . Of course, feel free to hit me up with questions.

    Sorry for taking so long to get back to you... The design of the system is to mainly be invisible to the user. The selector is mostly for authors and contributors. So we automatically detect your platform and Firefox version and then show you the appropriate instructions. Since mobile and desktop are so different and the vast majority of desktop articles aren't even applicable to mobile we thought it best to default to showing Windows instructions when you are looking at a desktop article with your mobile device (<90% of our users use Windows). Also, if you look at a mobile article from your desktop we of course show you the mobile instructions. If we didn't do this and you were trying to get help for your desktop while using a mobile device you'd arrive at an article and see that it was empty (or just had an introduction). Then you'd have to discover the selector in the sidebar and set it to the platform and version you wanted. A new article can be created here - https://support.mozilla.org/en-US/kb/new Since telemetry is only available in Aurora you should include this template https://support.mozilla.org/en-US/kb/templateapplytofx Also, be sure to talk to [https://support.mozilla.org/en-US/user/463178 Michelle], the mobile support coordinator. This article is a brief intro to our KB and has the rest of the KB documentation linked at the bottom - [[Improve the Knowledge Base]] . Of course, feel free to hit me up with questions.