Knowledge Base discussions

KB update / l10n process feedback

  • 8 Replies
  • Última resposta por AliceWyman
  1. vesper
    vesper 1182 mensagens
    more options

    (cross-posted from the L10n forum)

    Hello, SUMO Editors of all locales!

    We have an idea we wanted to share with you to get your feedback and (hopefully) approval and cooperation with making KB edits and localization work much better for everyone. We discussed the process and the general landscape with Joni in the recent weeks.

    It is also meant to address the forum thread in which many of you have voiced their concerns about the way the KB is being edited and updated right now.

    While it is not possible to make KB editing and localizing fit all of your personal styles and preferences, a unified process that everyone agrees and adheres to should help us alleviate a lot of possible pains.

    We would like to reiterate and reinforce the best practices around the KB editing and localization process by introducing a KB-wide release calendar and updated review guidelines for English reviewers. This pertains to release-related articles only, not one-offs related to marketing campaigns. For one-off articles, we will require a two-week lead time from other teams.

    For those who prefer a full description, please read on:

    Release-based KB Editing Timeline (codename: RocKET)

    6 weeks before next release / release week for current release

    • No work on next release content for English; minor fixes for existing English content; please avoid setting edited articles to RFL unless it’s critical (consult Joni or another admin)
    • Localizers finish content localization and fix potential last-minute issues with release content - this has priority over other existing content (= non-current-release), that can be localized as usual

    5 weeks before next release / 1 week after current release

    • No work on next release content for KB editors or localizers
    • All existing content is open for editing and localization as usual; please focus on localizing the most recent / popular content

    4 weeks before next release / 2 weeks after current release

    • Joni starts planning and drafting content for the next release; no work for localizers for the next release yet
    • All existing content is open for editing and localization as usual; please focus on localizing the most recent / popular content

    3 weeks before next release / 3 weeks after current release

    • Joni finishes working on next release content by end of this week; no work for localizers for the next release yet
    • All existing content is open for editing and localization as usual; please focus on localizing the most recent / popular content

    2 weeks before next release / 4 weeks after current release

    • Only Joni or other admins can introduce and/or approve potential last minute changes of next release content; only Joni or other admins can set new content to RFL; localizers should focus on this content
    • All other existing content is deprioritized, but can be edited and localized as usual

    1 week before next release / 5 weeks after current release

    • Only Joni or other admins can introduce and/or approve potential last minute changes of next release content; only Joni or other admins can set new content to RFL; localizers should focus on this content
    • All other existing content is deprioritized, but can be edited and localized as usual

    Questions? Comments? Write below!

    ''[https://support.mozilla.org/forums/l10n-forum/712068 (cross-posted from the L10n forum)]'' Hello, SUMO Editors of all locales! We have an idea we wanted to share with you to get your feedback and (hopefully) approval and cooperation with making KB edits and localization work much better for everyone. We discussed the process and the general landscape with [https://support.mozilla.org/user/jsavage/ Joni] in the recent weeks. It is also meant to [https://support.mozilla.org/forums/knowledge-base-articles/711969?last=69444 address the forum thread] in which many of you have voiced their concerns about the way the KB is being edited and updated right now. While it is not possible to make KB editing and localizing fit all of your personal styles and preferences, a unified process that everyone agrees and adheres to should help us alleviate a lot of possible pains. We would like to reiterate and reinforce the best practices around the KB editing and localization process by introducing a KB-wide release calendar and updated review guidelines for English reviewers. This pertains to release-related articles only, not one-offs related to marketing campaigns. For one-off articles, we will require a two-week lead time from other teams. * [https://docs.google.com/spreadsheets/d/1lMM0vNHBCgnQ4fZ9eZm_lO4al6HQRIfcrQb1Ui4BDts/edit#gid=0 Here is a spreadsheet with the whole flow explained in convenient columns]. * [https://docs.google.com/document/d/1pFOFjZAsGfdu0-Z9aVFnTMWbn57AUg1pLDmwBLxOWRE/edit?usp=sharing Draft of updated review guidelines (comment with your feedback).] For those who prefer a full description, please read on: '''Release-based KB Editing Timeline''' ''(codename: RocKET)'' '''6 weeks before next release / release week for current release''' * No work on next release content for English; minor fixes for existing English content; please avoid setting edited articles to RFL unless it’s critical (consult Joni or another admin) * Localizers finish content localization and fix potential last-minute issues with release content - this has priority over other existing content (= non-current-release), that can be localized as usual '''5 weeks before next release / 1 week after current release''' * No work on next release content for KB editors or localizers * All existing content is open for editing and localization as usual; please focus on localizing the most recent / popular content '''4 weeks before next release / 2 weeks after current release''' * Joni starts planning and drafting content for the next release; no work for localizers for the next release yet * All existing content is open for editing and localization as usual; please focus on localizing the most recent / popular content '''3 weeks before next release / 3 weeks after current release''' * Joni finishes working on next release content by end of this week; no work for localizers for the next release yet * All existing content is open for editing and localization as usual; please focus on localizing the most recent / popular content '''2 weeks before next release / 4 weeks after current release''' * Only Joni or other admins can introduce and/or approve potential last minute changes of next release content; only Joni or other admins can set new content to RFL; localizers should focus on this content *All other existing content is deprioritized, but can be edited and localized as usual '''1 week before next release / 5 weeks after current release''' * Only Joni or other admins can introduce and/or approve potential last minute changes of next release content; only Joni or other admins can set new content to RFL; localizers should focus on this content * All other existing content is deprioritized, but can be edited and localized as usual Questions? Comments? Write below!

    Modificado por vesper em

  2. AliceWyman
    AliceWyman 6313 mensagens
    more options

    You wrote, This pertains to release-related articles only, not one-offs related to marketing campaigns. For one-off articles, we will require a two-week lead time from other teams.

    What are release-related articles? What are one-offs related to marketing campaigns? Could you link to some articles as examples?

    In addition to those two article categories, do the proposed new rules also apply to the "top articles"? See the current Article review guidelines article under Top articles and Ready for localization/Top article "freeze" sections.

    In general, if the guidelines get too complicated, reviewers like me may avoid marking any articles as ready to localize. Will admin be responsible for reviewing the https://support.mozilla.org/en-US/contributors/unready Changes not Ready for Localization list, to make sure that important articles don't get overlooked?

    You wrote, ''This pertains to release-related articles only, not one-offs related to marketing campaigns. For one-off articles, we will require a two-week lead time from other teams.'' What are release-related articles? What are one-offs related to marketing campaigns? Could you link to some articles as examples? In addition to those two article categories, do the proposed new rules also apply to the "top articles"? See the current [[Article review guidelines]] article under Top articles and Ready for localization/Top article "freeze" sections. In general, if the guidelines get too complicated, reviewers like me may avoid marking any articles as ready to localize. Will admin be responsible for reviewing the https://support.mozilla.org/en-US/contributors/unready Changes not Ready for Localization list, to make sure that important articles don't get overlooked?
  3. AliceWyman
    AliceWyman 6313 mensagens
    more options

    P.S. Should we reply here or in the L10n forum thread?

    P.S. Should we reply here or in the [https://support.mozilla.org/en-US/forums/l10n-forum/712068 L10n forum thread]?

    Modificado por AliceWyman em

  4. vesper
    vesper 1182 mensagens
    more options

    Thank you, Alice!

    AliceWyman said

    P.S. Should we reply here or in the L10n forum thread?

    One reply for both threads is enough. We do have localizers and KB editors using both subforums separately, so I wanted to make sure everyone sees the message.

    Everyone's feedback will be collated, and you're welcome to cross-reference posts in both discussion threads, too. This is a single discussion happening in two places.

    AliceWyman said

    You wrote, This pertains to release-related articles only, not one-offs related to marketing campaigns. For one-off articles, we will require a two-week lead time from other teams. What are release-related articles? What are one-offs related to marketing campaigns? Could you link to some articles as examples?

    I will let Joni pick the best examples for these, but in short:

    • release-related articles are (mostly) articles written from scratch to cover new functionality or serious changes to the user experience (e.g. "What's New In..." articles for Android OS / iOS versions - but also significant updates to existing articles that expand or alter article content (e.g. adding sections for Windows 10- or Linux-only options in feature articles, if that's necessary due to a new release)
    • one-offs for marketing campaigns may include non-release-based changes to existing articles or selected articles that describe features chosen by the marketing team to be promoted through a newsletter (or other) campaign - this could be privacy-related features, for example.

    AliceWyman said

    In addition to those two article categories, do the proposed new rules also apply to the "top articles"? See the current Article review guidelines article under Top articles and Ready for localization/Top article "freeze" sections.

    Top articles as such are "normal articles" (that just have a lot of visits), and while they should be prioritized by localizers (as per the way our l10n dashboards work and display content), they do not need special attention unless they fall into any of the two above categories.

    AliceWyman said

    In general, if the guidelines get too complicated, reviewers like me may avoid marking any articles as ready to localize. Will admin be responsible for reviewing the https://support.mozilla.org/en-US/contributors/unready Changes not Ready for Localization list, to make sure that important articles don't get overlooked?

    That is a very good point - again, I'll let Joni answer in more detail if it's needed - Joni is the main person responsible for making sure each release has the right content updated/created; I am the main person responsible for making sure each release has that content localized as much as possible. Thus, no important article should be overlooked for the process to work, and the admins will take care of that - with your feedback welcome, as always.

    Thank you, Alice! ''AliceWyman [[#post-69561|said]]'' <blockquote> P.S. Should we reply here or in the [https://support.mozilla.org/en-US/forums/l10n-forum/712068 L10n forum thread]? </blockquote> One reply for both threads is enough. We do have localizers and KB editors using both subforums separately, so I wanted to make sure everyone sees the message. Everyone's feedback will be collated, and you're welcome to cross-reference posts in both discussion threads, too. This is a single discussion happening in two places. ''AliceWyman [[#post-69560|said]]'' <blockquote> You wrote, ''This pertains to release-related articles only, not one-offs related to marketing campaigns. For one-off articles, we will require a two-week lead time from other teams.'' What are release-related articles? What are one-offs related to marketing campaigns? Could you link to some articles as examples?</blockquote> I will let Joni pick the best examples for these, but in short: * release-related articles are (mostly) articles written from scratch to cover new functionality or serious changes to the user experience (e.g. "What's New In..." articles for Android OS / iOS versions - but also significant updates to existing articles that expand or alter article content (e.g. adding sections for Windows 10- or Linux-only options in feature articles, if that's necessary due to a new release) * one-offs for marketing campaigns may include non-release-based changes to existing articles or selected articles that describe features chosen by the marketing team to be promoted through a newsletter (or other) campaign - this could be privacy-related features, for example. ''AliceWyman [[#post-69560|said]]'' <blockquote> In addition to those two article categories, do the proposed new rules also apply to the "top articles"? See the current [[Article review guidelines]] article under Top articles and Ready for localization/Top article "freeze" sections. </blockquote> Top articles as such are "normal articles" (that just have a lot of visits), and while they should be prioritized by localizers (as per the way our l10n dashboards work and display content), they do not need special attention ''unless'' they fall into any of the two above categories. ''AliceWyman [[#post-69560|said]]'' <blockquote> In general, if the guidelines get too complicated, reviewers like me may avoid marking any articles as ready to localize. Will admin be responsible for reviewing the https://support.mozilla.org/en-US/contributors/unready Changes not Ready for Localization list, to make sure that important articles don't get overlooked? </blockquote> That is a very good point - again, I'll let Joni answer in more detail if it's needed - Joni is the main person responsible for making sure each release has the right content updated/created; I am the main person responsible for making sure each release has that content localized as much as possible. Thus, no important article should be overlooked for the process to work, and the admins will take care of that - with your feedback welcome, as always.
  5. Chris Ilias
    Chris Ilias 2448 mensagens
    more options

    I'm not a localizer, so I have no opinion on when/who to mark edits as RFL (Just tell me what to do).

    I don't like preventing en-US contributors from updating articles. If an article requires a major update for an upcoming release, are volunteers allowed to do the update, without marking RFL?

    A month ago Template:aboutconfig was updated for Firefox 49 (13 weeks before release) by a volunteer. If I understand the proposal correctly, it's okay to mark that edit as ready for localization, because even though it's an update for a future release, it's not a big change to the template. Is that correct?

    I'm still unsure if the updates needed for How does built-in Phishing and Malware Protection work? and Security and passwords settings due to UI changes for safebrowsing in Firefox 48 would be considered significant. Should I bother with it?

    I'm not a localizer, so I have no opinion on when/who to mark edits as RFL (Just tell me what to do). I don't like preventing en-US contributors from updating articles. If an article requires a major update for an upcoming release, are volunteers allowed to do the update, without marking RFL? A month ago [https://support.mozilla.org/kb/Template:aboutconfig/history Template:aboutconfig] was updated for Firefox 49 (13 weeks before release) by a volunteer. If I understand the proposal correctly, it's okay to mark that edit as ready for localization, because even though it's an update for a future release, it's not a big change to the template. Is that correct? I'm still unsure if the updates needed for [[How does built-in Phishing and Malware Protection work?]] and [[Security and passwords settings]] due to UI changes for safebrowsing in Firefox 48 would be considered significant. Should I bother with it?
  6. Joni
    Joni 361 mensagens
    more options

    An example of "one-off" articles:

    Release-related article:

    If an article requires a major update for an upcoming release, are volunteers allowed to do the update, without marking RFL?

    I think what we want to essentially avoid is marking them RFL too close to a release. With that in mind, I don't foresee any problems with volunteers making urgent and significant updates (i.e. changes to instructions) without marking RFL. Do others see an issue with that?

    To answer Alice's question, Admins would be responsible for marking articles RFL. Core contributors are welcome to do this too, but I will check the dashboard closer to the release and take care of the ones that are left.

    A month ago Template:aboutconfig was updated for Firefox 49 (13 weeks before release) by a volunteer. If I understand the proposal correctly, it's okay to mark that edit as ready for localization, because even though it's an update for a future release, it's not a big change to the template. Is that correct?

    I would consider this a significant (maybe "big"' is not the right word) change because it's a change in instructions (the text on the button is now different). We would mark it RFL because it's significant, but we wouldn't mark it until three weeks before release in case the instructions have to change again.

    If it were a minor change (adding screenshots, fixing grammar and other things that only affect en-us), we would not mark it as RFL at all.

    Any other feedback or questions? Please share.

    An example of "one-off" articles: *[[Tips for safe online shopping]] Release-related article: *[[What's New in Firefox for iOS (version 5.0)]] <blockquote>If an article requires a major update for an upcoming release, are volunteers allowed to do the update, without marking RFL?</blockquote> I think what we want to essentially avoid is marking them RFL too close to a release. With that in mind, I don't foresee any problems with volunteers making urgent and significant updates (i.e. changes to instructions) without marking RFL. Do others see an issue with that? To answer Alice's question, Admins would be responsible for marking articles RFL. Core contributors are welcome to do this too, but I will check the dashboard closer to the release and take care of the ones that are left. <blockquote> A month ago Template:aboutconfig was updated for Firefox 49 (13 weeks before release) by a volunteer. If I understand the proposal correctly, it's okay to mark that edit as ready for localization, because even though it's an update for a future release, it's not a big change to the template. Is that correct? </blockquote> I would consider this a significant (maybe "big"' is not the right word) change because it's a change in instructions (the text on the button is now different). We would mark it RFL because it's significant, but we wouldn't mark it until three weeks before release in case the instructions have to change again. If it were a minor change (adding screenshots, fixing grammar and other things that only affect en-us), we would not mark it as RFL at all. Any other feedback or questions? Please share.
  7. vesper
    vesper 1182 mensagens
    more options

    Joni powiedział

    To answer Alice's question, Admins would be responsible for marking articles RFL. Core contributors are welcome to do this too, but I will check the dashboard closer to the release and take care of the ones that are left.

    Like Joni said - we are not going to stop anyone from contributing (and marking content as RFL) in the "usual" period, but before launches we would like to have fewer non-release tasks for localizers - hence the tighter controls over "RFLing" articles closer to release dates.

    ''Joni [[#post-69582|powiedział]]'' <blockquote> To answer Alice's question, Admins would be responsible for marking articles RFL. Core contributors are welcome to do this too, but I will check the dashboard closer to the release and take care of the ones that are left. </blockquote> Like Joni said - we are not going to stop anyone from contributing (and marking content as RFL) in the "usual" period, but before launches we would like to have fewer non-release tasks for localizers - hence the tighter controls over "RFLing" articles closer to release dates.
  8. AliceWyman
    AliceWyman 6313 mensagens
    more options

    From https://public.etherpad-mozilla.org/p/sumo-2016-08-24

    Knowledge Base: We're here: 3 weeks before next release / 3 weeks after current release Joni finishes working on next release content by end of this week; no work for localizers for the next release yet All existing content is open for editing and localization as usual; please focus on localizing the most recent / popular content Next week: 2 weeks before next release / 4 weeks after current release Only Joni or other admins can introduce and/or approve potential last minute changes of next release content; only Joni or other admins can set new content to RFL; localizers should focus on this content All other existing content is deprioritized, but can be edited and localized as usual source: https://support.mozilla.org/forums/knowledge-base-articles/712069

    Shouldn't Article review guidelines be updated when new rules are created? It's not fair to expect reviewers to follow rules set forth in various etherpads and discussion forum threads when we have a "How to contribute" KB article for that purpose.

    Related discussion thread, posted June 21, 2016: https://support.mozilla.org/en-US/kb/article-review-guidelines/discuss/6689 [Attn: Admin/Joni] Review and clarify "Top article "freeze" period

    From https://public.etherpad-mozilla.org/p/sumo-2016-08-24 <blockquote> Knowledge Base: We're here: 3 weeks before next release / 3 weeks after current release Joni finishes working on next release content by end of this week; no work for localizers for the next release yet All existing content is open for editing and localization as usual; please focus on localizing the most recent / popular content Next week: 2 weeks before next release / 4 weeks after current release Only Joni or other admins can introduce and/or approve potential last minute changes of next release content; only Joni or other admins can set new content to RFL; localizers should focus on this content All other existing content is deprioritized, but can be edited and localized as usual source: https://support.mozilla.org/forums/knowledge-base-articles/712069 </blockquote> Shouldn't [[Article review guidelines]] be updated when new rules are created? It's not fair to expect reviewers to follow rules set forth in various etherpads and discussion forum threads when we have a "How to contribute" KB article for that purpose. Related discussion thread, posted June 21, 2016: https://support.mozilla.org/en-US/kb/article-review-guidelines/discuss/6689 [Attn: Admin/Joni] Review and clarify "Top article "freeze" period
  9. AliceWyman
    AliceWyman 6313 mensagens
    more options

    I made some edits to the pending revision to Article review guidelines (thanks, Michał) and approved the changes.

    To Joni: Can you look over the new version for any other needed changes?

    I made some edits to the pending revision to [[Article review guidelines]] (thanks, Michał) and approved the changes. '''To Joni: ''' Can you look over the new version for any other needed changes?