Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,16 @@ renderer = ["html"]
git-repository-url = "https://github.com/mozilla-l10n/documentation/"
edit-url-template = "https://github.com/mozilla-l10n/documentation/edit/main/{path}"
no-section-label = true

[output.html.redirect]
"/tools/pontoon/index.html" = "https://pontoon.mozilla.org/docs/admin/"
"/tools/pontoon/adding_new_project.html" = "https://pontoon.mozilla.org/docs/admin/adding-new-project/"
"/tools/pontoon/adding_new_short_term_project.html" = "https://pontoon.mozilla.org/docs/admin/adding-new-db-project/"
"/tools/pontoon/adding_new_locale.html" = "https://pontoon.mozilla.org/docs/admin/adding-new-locale/"
"/tools/pontoon/managing_pretranslation.html" = "https://pontoon.mozilla.org/docs/admin/managing-pretranslation/"
"/tools/pontoon/messaging_center.html" = "https://pontoon.mozilla.org/docs/admin/messaging-center/"
"/tools/pontoon/renaming_a_file.html" = "https://pontoon.mozilla.org/docs/admin/renaming-file/"
"/tools/pontoon/renaming_a_project.html" = "https://pontoon.mozilla.org/docs/admin/renaming-project/"
"/tools/pontoon/deactivating_users.html" = "https://pontoon.mozilla.org/docs/admin/managing-users/"
"/tools/pontoon/removing_users.html" = "https://pontoon.mozilla.org/docs/admin/managing-users/"
"/tools/pontoon/adding_new_terminology.html" = "https://pontoon.mozilla.org/docs/admin/adding-terminology/"
2 changes: 1 addition & 1 deletion src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This repository includes several documents describing how to perform internal ta
Topics covered:
* How to [review strings](products/firefox_desktop/review.md) for Firefox desktop.
* Manage [other projects](products/other/) (Firefox Monitor, VPN Client).
* Perform common and advanced tasks on [Pontoon](tools/pontoon/) like adding new locale, and creating a new project.
* Perform common and advanced tasks on [Pontoon](https://pontoon.mozilla.org/docs/admin/) like adding new locale, and creating a new project.
* Other [miscellaneous documents](misc/) related to localization tasks.

## How to read these documents
Expand Down
14 changes: 0 additions & 14 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,20 +34,6 @@
* [Mobile](products/mobile/README.md)
* [L10N FAQs](products/mobile/mobile_l10n_faqs.md).

## Tools

* [Pontoon](tools/pontoon/README.md)
* [New project](tools/pontoon/adding_new_project.md).
* [Renaming a project](tools/pontoon/renaming_a_project.md).
* [New short-term project](tools/pontoon/adding_new_short_term_project.md).
* [New locale](tools/pontoon/adding_new_locale.md).
* [Pretranslation](tools/pontoon/managing_pretranslation.md).
* [Messaging Center](tools/pontoon/messaging_center.md).
* [Renaming a localization file](tools/pontoon/renaming_a_file.md).
* [Deactivating users](tools/pontoon/deactivating_users.md).
* [Removing users](tools/pontoon/removing_users.md).
* [New terminology](tools/pontoon/adding_new_terminology.md).

## Misc

* [Other docs](misc/README.md)
Expand Down
Binary file not shown.
4 changes: 2 additions & 2 deletions src/products/android-l10n/adding_projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Follow the steps below to add new projects to [android-l10n](https://github.com/

## Setting up the project in source and l10n repositories

Before anything happens, check that the new project is properly localizable by following the directions in [this section](https://github.com/mozilla-l10n/documentation/blob/main/src/tools/pontoon/adding_new_project.md#adding-a-new-project-on-pontoon). Once the new project exists in its corresponding source repository and is ready, it can then be added to the `android-l10n` repository.
Before anything happens, check that the new project is properly localizable by following the directions in [this section](https://pontoon.mozilla.org/docs/admin/adding-new-project/). Once the new project exists in its corresponding source repository and is ready, it can then be added to the `android-l10n` repository.

Android developers need to create a TOML file in their code directory and under its corresponding project folder ([example for fenix](https://github.com/mozilla-firefox/firefox/blob/main/mobile/android/fenix/l10n.toml)), as well as the file containing the source strings in `res/values/strings.xml` ([example for fenix](https://github.com/mozilla-firefox/firefox/blob/main/mobile/android/fenix/app/src/main/res/values/strings.xml)). The `mobile/android` directory in `mozilla-firefox` contains all [current Android projects](https://github.com/mozilla-firefox/firefox/tree/main/mobile/android).

Expand All @@ -22,6 +22,6 @@ Once automation is in place, it will automatically extract new English strings a

## Add and manage the project in Pontoon

Once all of this is done and merged, you can now enable the new project in Pontoon (see [instructions for adding new projects](https://github.com/mozilla-l10n/documentation/blob/main/src/tools/pontoon/adding_new_project.md#create-the-project)).
Once all of this is done and merged, you can now enable the new project in Pontoon (see [instructions for adding new projects](https://pontoon.mozilla.org/docs/admin/adding-new-project/)).

Going forward, remember to update the localization completion deadline under Pontoon resources. For existing Android projects, the deadline falls one day before the *Release Candidate* date of the current [Beta version](https://whattrainisitnow.com/release/?version=beta). They follow the same four-week release cycle as other Firefox browsers, so these deadlines must be updated regularly. When setting up a new project, confirm what type of release cycle it will follow. To update, navigate to the [Pontoon admin](https://pontoon.mozilla.org/admin/) page, select your project, and update the *Target date*.
2 changes: 1 addition & 1 deletion src/products/android-l10n/updating_locales.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Note that:

## Updating locales in Pontoon

Once the patch has landed, the locale has to be added — or removed — in Pontoon as well. The steps to follow can be found in the existing [Pontoon documentation](https://github.com/mozilla-l10n/documentation/blob/main/src/tools/pontoon/adding_new_locale.md).
Once the patch has landed, the locale has to be added — or removed — in Pontoon as well. The steps to follow can be found in the existing [Pontoon documentation](https://pontoon.mozilla.org/docs/admin/adding-new-locale/).

One thing to note is that, once you merge the pull request adding or removing locales in the localization repository, automation will send that updated list over to the `mozilla-firefox` Android [code repository](https://github.com/mozilla-firefox/firefox/tree/main/mobile/android).

Expand Down
2 changes: 1 addition & 1 deletion src/products/firefox_desktop/adding_pontoon.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Adding a new locale to Pontoon

* If the locale is not [available](https://pontoon.mozilla.org/teams/) in Pontoon yet, [consult this document](../../tools/pontoon/adding_new_locale.md) for instructions on how to add it.
* If the locale is not [available](https://pontoon.mozilla.org/teams/) in Pontoon yet, [consult this document](https://pontoon.mozilla.org/docs/admin/adding-new-locale/) for instructions on how to add it.
* Enable the locale for Firefox from the [project admin interface](https://pontoon.mozilla.org/admin/projects/firefox/) by moving your locale from the Available column to the Localizable column.
* Initialize the `toolkit/chrome/global/intl.properties` file with the correct values: ([example](https://github.com/mozilla-l10n/firefox-l10n/commit/a887bff12994779ea8e605f4abc1b240a287ccb9)).
4 changes: 2 additions & 2 deletions src/products/iOS_products/adding_projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ We will go over the steps to set up a new iOS project, using current iOS project

## Setting up the project in source and l10n repositories

Before anything happens, check that the new project is properly localizable by following the directions in [this section](../../tools/pontoon/adding_new_project.md#adding-a-new-project-on-pontoon).
Before anything happens, check that the new project is properly localizable by following the directions in [this section](https://pontoon.mozilla.org/docs/admin/adding-new-project/).

Note that the existing iOS projects — Firefox for iOS and Focus for iOS — share the same [source repository](https://github.com/mozilla-mobile/firefox-ios) as they have a significant amount of common code.

Expand All @@ -16,7 +16,7 @@ The first step is to make sure we can extract and use strings in an XLIFF file.

A GitHub workflow (see examples for [Firefox](https://github.com/mozilla-l10n/firefoxios-l10n/blob/main/.github/workflows/import_strings.yml) and [Focus](https://github.com/mozilla-l10n/focusios-l10n/blob/main/.github/workflows/import_strings.yml)) should be used to extract en-US strings from the code repository, clean up files, and expose them to all locales. In order to provide more autonomy, the workflow to extract strings should run on a regular schedule, but it should also be possible to execute it manually, like it happens for Firefox or Focus. Coordinate with a technical localization EPM to set this up.

You can now enable the new project in Pontoon (see [instructions for adding new projects](../../tools/pontoon/adding_new_project.md#create-the-project)).
You can now enable the new project in Pontoon (see [instructions for adding new projects](https://pontoon.mozilla.org/docs/admin/adding-new-project/)).

Going forward, remember to update the localization completion deadline under Pontoon resources. For existing iOS projects, the deadline falls one day before the *Release Candidate* date of the current [Beta version](https://whattrainisitnow.com/release/?version=beta). They follow the same four-week release cycle as other Firefox browsers, so these deadlines must be updated regularly. When setting up a new project, confirm what type of release cycle it will follow. To update, navigate to the [Pontoon admin](https://pontoon.mozilla.org/admin/) page, select your project, and update the *Target date*.

Expand Down
2 changes: 1 addition & 1 deletion src/products/iOS_products/updating_locales.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ To check if a locale is supported on iOS, look directly on a device under Langua

## Updating locales in Pontoon

Once you’ve determined if the locale can be added, you must go to Pontoon to update the list of current locales. If the locale is not [available](https://pontoon.mozilla.org/teams/) in Pontoon yet, [consult this document](../../tools/pontoon/adding_new_locale.md) for instructions on how to add it.
Once you’ve determined if the locale can be added, you must go to Pontoon to update the list of current locales. If the locale is not [available](https://pontoon.mozilla.org/teams/) in Pontoon yet, [consult this document](https://pontoon.mozilla.org/docs/admin/adding-new-locale/) for instructions on how to add it.

In Pontoon, you can add and remove locales from the admin project page: [here](https://pontoon.mozilla.org/admin/projects/firefox-for-ios/) for Firefox for iOS, and [here](https://pontoon.mozilla.org/admin/projects/focus-for-ios/) for Focus for iOS. The project will be available after the next [Pontoon sync](https://pontoon.mozilla.org/sync/).

Expand Down
2 changes: 1 addition & 1 deletion src/products/mozilla_org/manage_review_mozilla_org.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ This section covers some common tasks in Pontoon.

### Add tags

The Mozilla.org project consists of many files, so [Pontoon Tags](https://mozilla-l10n.github.io/documentation/tools/pontoon/adding_new_project.html#tags) can be used to help localizers prioritize specific content. Given the lack of clarity from the marketing team, this is rarely used nowadays.
The Mozilla.org project consists of many files, so [Pontoon Tags](https://pontoon.mozilla.org/docs/admin/adding-new-project/#tags) can be used to help localizers prioritize specific content. Given the lack of clarity from the marketing team, this is rarely used nowadays.

Tags can also be used to group files, for example to track completion of pages associated with a specific initiative (e.g. VPN market expansion).

Expand Down
13 changes: 0 additions & 13 deletions src/tools/pontoon/README.md

This file was deleted.

115 changes: 0 additions & 115 deletions src/tools/pontoon/adding_new_locale.md

This file was deleted.

Loading