Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write upgrade messages, and incorporate step into release process #7452

Closed
3 tasks done
indirectlylit opened this issue Aug 7, 2020 · 0 comments · Fixed by #7984
Closed
3 tasks done

Write upgrade messages, and incorporate step into release process #7452

indirectlylit opened this issue Aug 7, 2020 · 0 comments · Fixed by #7984
Assignees
Labels
P0 - critical Priority: Release blocker or regression TAG: dev experience Build performance, linting, debugging... TAG: developer docs Technical docs and code comments TAG: user strings Application text that gets translated
Milestone

Comments

@indirectlylit
Copy link
Contributor

indirectlylit commented Aug 7, 2020

Observed behavior

For release 0.14, we forgot to create strings advertising the 0.14 upgrade, which means we'll need to use upgradeMessageGeneric for most languages:

// The strings below are not actually used in the appplication code.
// They are included simply to get the strings translated for later use. We should do
// this differently in the longer-term to ensure that we have broader language support.
/* eslint-disable kolibri/vue-no-unused-translations */
upgradeHeader: 'Upgrade available',
upgradeHeaderImportant: 'Important upgrade available',
upgradeMessageGeneric: 'A new version of Kolibri is available.',
upgradeMessageImportant:
'We have released an important update with fixes to this version of Kolibri.',
upgradeMessage0130:
'Kolibri version 0.13.0 is available! It contains major improvements to resource management, coach tools, and much more.',
upgradeDownload: 'Download it here',
upgradeLearnAndDownload: 'Learn more and download it here',
/* eslint-enable kolibri/vue-no-unused-translations */

Additionally, the current release process checklist does not contain guidance on using the nutritionfacts_i18n.py script in order to distinguish custom messages from the generic one:

@click.option(
"--title",
default="UpdateNotification.upgradeHeader",
help="Title string ID",
type=str,
)
@click.option(
"--message",
default="UpdateNotification.upgradeMessageGeneric",
help="Message string ID",
type=str,
)
@click.option(
"--link-text",
default="UpdateNotification.upgradeLearnAndDownload",
help="Link text string ID",
type=str,
)
def main(title, message, link_text):
"""
Generate JSON suitable for sending in nutrition facts notifications
"""

Expected behavior

For 0.15:

  • create an appropriate message prior to string freeze and put it in UpdateNotification.vue
  • add this step to the "String chill and string freeze" section of the Release process developer docs so it's not missed in future releases
  • update the release process checklist to give guidance on selecting custom messages when available

User-facing consequences

Existing users will not have enough context on the content of new major releases

Context

0.14.0

@indirectlylit indirectlylit added P1 - important Priority: High impact on UX TAG: dev experience Build performance, linting, debugging... TAG: user strings Application text that gets translated labels Aug 7, 2020
@indirectlylit indirectlylit added this to the 0.15.0 milestone Aug 7, 2020
@nucleogenesis nucleogenesis added P0 - critical Priority: Release blocker or regression TAG: developer docs Technical docs and code comments and removed P1 - important Priority: High impact on UX labels Mar 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P0 - critical Priority: Release blocker or regression TAG: dev experience Build performance, linting, debugging... TAG: developer docs Technical docs and code comments TAG: user strings Application text that gets translated
Projects
None yet
3 participants