1416160 - Document basic Pontoon+FTL workflow

Status: RESOLVED FIXED

(Core :: Internationalization: Localization, enhancement)

Description

[Zibi Braniecki [:zbraniecki][:gandalf]]

As we're introducing first Fluent localizations of Firefox, it becomes valuable to have some basic documentation of the Fluent specific Pontoon UI/UX features.

Pike suggested to start with the list of Pontoon features that are being added as part of bug 1407256.

Comment 1

[Zibi Braniecki [:zbraniecki][:gandalf]]

Flod, Jeff - would you be able to take this?

Comment 2

[Francesco Lodolo [:flod]]

I can take care of this. 

Ideally, I'd prefer to document every UI change related to FTL when it lands, more than doing it afterwards. A ping in in the bug or PR would be enough.

Comment 3

[Francesco Lodolo [:flod]]

Note: I don't think this blocks first migration. If nothing else, because we already have projects using FTL in Pontoon.

Comment 4

[Zibi Braniecki [:zbraniecki][:gandalf]]

Pike - you set this bug on the dependency for first-migration. Do you agree with :flod?

Comment 5

[Axel Hecht [:Pike]]

I'm wondering if we shouldn't at least have attributes documented. They are already used, but sparsely, and only in screenshots and the test pilot website AFAICT. Pontoon DB says we have 74 locales with existing translations for those strings.

Comment 6

[Francesco Lodolo [:flod]]

(In reply to Axel Hecht [:Pike] from comment #5)
> I'm wondering if we shouldn't at least have attributes documented. They are
> already used, but sparsely, and only in screenshots and the test pilot
> website AFAICT. Pontoon DB says we have 74 locales with existing
> translations for those strings.

They are, maybe not in full depth
https://mozilla-l10n.github.io/localizer-documentation/tools/pontoon/ui.html#translation-workspace

Not sure if, at some point, we'll have to put all the FTL information in one doc.

Comment 7

[Zibi Braniecki [:zbraniecki][:gandalf]]

Flod - can you make a call on whether this should block First Migration pls? Based on your comment 3 I'd like to take it off from the blocker list, but I'd like to know which milestone this bug should block.

Comment 8

[Axel Hecht [:Pike]]

We should have specific bugs for specific fluent features for milestone, I think.

As far as first migration goes, I think we're documentation-complete with the last update.

Not sure if we should resolve this bug or leave it open.

Comment 9

[Francesco Lodolo [:flod]]

(In reply to Zibi Braniecki [:gandalf][:zibi] from comment #7)
> Flod - can you make a call on whether this should block First Migration pls?
> Based on your comment 3 I'd like to take it off from the blocker list, but
> I'd like to know which milestone this bug should block.

If the call is mine, documentation shouldn't block the first migration (see also comment 3).

Given the subject of the bug ("basic ftl workflow"), I think we're covered and I'll close this one.

We use issue to track documentation needs
https://github.com/mozilla-l10n/documentation/issues (internal)
https://github.com/mozilla-l10n/localizer-documentation/issues (localizers)

My suggestion would be to file an issue there for every feature implemented in Pontoon, and likely use a whiteboard flags to make search possible (e.g. l10n-docs-needed). Since I have visibility on Pontoon's bugs, I can take care of both.