mozilla-l10n/localizer-documentation

Pontoon documentation updates: resources.md

Closed this issue · 2 comments

Sub-issue of #203

Overall

  • A lot of this documentation is to the "what" of Pontoon features. I'd like to make this documentation a good starting point for new contributors, so perhaps more time spent on the "how" and "why" to use a feature, perhaps mixing in basic localization concepts might help create a better resource we can more readily point new contributors to.

That being said, here are specific issues that need to be fixed:

History Tab

  • History is no longer a separate tab, so this text needs updating:

History tab

The history tab shows all of the suggestions and translations that have been submitted for the current source string.

In the tab, the number of available entries is visible alongside the HISTORY title. The history entries are located below the tab.

  • Screenshot showing history section requires update
  • Current UI displays only displays DIFF with styling indicating on and off, so below sentence needs to be recast

If there are multiple suggestions for one string, it’s possible to use the SHOW DIFF link displayed on the right side of the suggestion: it will compare the selected suggestion to the first entry, highlighting in green all added text, in red all removed text. HIDE DIFF will display the original string

  • Screenshots highlighting DIFF enabled and disabled need an update.
  • COMMENT also appears in the screenshots, but either a new section regarding comments and how to use them should be created, or perhaps added to an existing document like translate.md

Machinery tab

  • Screenshot requires update
  • Pontoon's internal translation memory: we should add a link to this. Either to the machinery search or another document.
  • This should be recast for clarity, this is tough for me to parse so may be next to impossible for a localizer starting out.

Note that when using the machinery tab, entry source string may not match the project source string and translations may not be fluent under the context of the project string. Be aware of the meaning and purpose of each string when using the machinery tab.

Locales tab

  • Update screenshot
  • A lot of this documentation is to the "what" of Pontoon features. I'd like to make this documentation a good starting point for new contributors, so perhaps more time spent on the "how" and "why" to use a feature, perhaps mixing in basic localization concepts might help create a better resource we can more readily point new contributors to.

Wouldn't this fit more in https://github.com/mozilla-l10n/localizer-documentation/blob/main/src/tools/pontoon/workflow.md?

(looks like "addresses" doesn't work as "fixes" to close the issue)