Add docs for adding a new l10n into product-details #89
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| FAQ | ||
| === | ||
|
|
||
| This piece of docs tracks frequently-asked-questions during our releaseduty cycles. | ||
|
|
||
| Adding a new locale into Product-Details | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| `Product details`_ is a public JSON API which contains release | ||
| information for Mozilla products. More information on this can be found | ||
| in `here`_. | ||
|
|
||
| Each time a new locale is being added so that we’re able to | ||
| ship a newly-localized Firefox in a different language, RelEng gets involved. | ||
| In order for that to happen, the l10n team adds the corresponding builds as a | ||
| pre-requisite. Then, they likely ping releaseduty: PR like `this`_ or | ||
| `this <https://github.com/mozilla-releng/product-details/pull/9>`__ are | ||
| opened against Product-details. TODO for releaseduty: | ||
|
|
||
|
|
||
| - double-check that the PR is listing another locale in the ``public/1.0/languages.json`` file. See samples PRs like `this`_ or `this <https://github.com/mozilla-releng/product-details/pull/9>`__ from the past | ||
|
There was a problem hiding this comment. You mean another locale = a new locale? |
||
| - review and merge the PR, either directly into ``production`` or via ``main`` and then follow-up with a push to ``production`` | ||
|
There was a problem hiding this comment. The PR is always done against There was a problem hiding this comment. Is the |
||
| - wait for the Taskcluster CI to run successfully. Behind the scenes, the CI is cloning the repo resources and pushes them to a S3 bucket | ||
| - once the CI is green, trigger the Product-Details rebuild via Ship-it: |product-details-rebuild| | ||
|
There was a problem hiding this comment. Note to self: I may be wrong here - pending a conclusion in the PR conversation. |
||
|
|
||
| .. _Product details: https://product-details.mozilla.org/1.0/ | ||
| .. _here: https://wiki.mozilla.org/Release_Management/Product_details | ||
| .. _this: https://github.com/mozilla-releng/product-details/pull/10 | ||
| .. |product-details-rebuild| image:: /procedures/release-duty/faq/media/product-details-rebuild.png | ||
|
There was a problem hiding this comment. Note to self: this URL will fix itself once we merge as the abspath will become valid in the main repo. |
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Based on our conversation elsewhere, and my reading of the code, I'm pretty sure that PRs against product-details are a bad idea. As far as I can tell, Ship It will rebuild product details based on the locales it finds in hg.mozilla.org (specifically,
browser/locales/l10n-changesets.json).So, a PR will work, but it will get overridden the next time we ship something, or trigger a manual rebuild of product details in Ship It.
Assuming this is all correct, this means that the correct procedure is:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I don't follow.
product-detailsis the only place where the language name is defined, and that's the only change that those PRs contain (it doesn't touch the actual build information).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It appears the PRs @MihaiTabara are pointing to change the
languages.jsonfile, which contains human-readable descriptions of the locales. It looks like the release services robot PRs don't updatelanguages.json, nor does l10n-changesets.json contain that information. We may need both, until or unless we add the additional human-readable information intol10n-changesets.jsonor similar, and update the bot to also updatelanguages.json.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay, I stand corrected!