Return translated fields for the Homepage Shelves

[bobsilverberg]

We are storing a title and footer_text for shelves defined in the admin, which are returned via the shelves endpoint. When this data is displayed on the front-end, it should be possible to display it in the user's current language. I believe two things are needed:

1. Extract the data for title and footer_text in order to make it localizable in a similar way that is being done for discovery items.
2. Return title and footer_text in the API response as translated fields, as opposed to simple strings.

[eviljeff]

Because the footer_text needs to be translatable, it also should change from an optional field to a mandatory field in the db and in the admin.

I thought we'd fall-back to generic "See more <title>"?

[eviljeff]

i.e. both footer_text and footer_pathname were optional overrides if the default "See more <title>" and the link to the full search/collection wasn't wanted.

[bobsilverberg]

We cannot have a default "See more <title>" because l10n. We cannot concatenate "See more" with the title from the db.

[eviljeff]

We cannot have a default "See more <title>" because l10n. We cannot concatenate "See more" with the title from the db.

Why? We have mixed content all over the site when the addon's content isn't localised. e.g. the main card at the top is "<addon.name> by: <addon.authors>" where <addon.name> might be localised in the current locale but often isn't and the author display names never are.

[bobsilverberg]

We cannot have a default "See more <title>" because l10n. We cannot concatenate "See more" with the title from the db.

Why? We have mixed content all over the site when the addon's content isn't localised. e.g. the main card at the top is "<addon.name> by: <addon.authors>" where <addon.name> might be localised in the current locale but often isn't and the author display names never are.

If there are places where we have that, then it's technically incorrect. We try to avoid that whenever possible, because in a different language it might be incorrect to say "See more", followed by the shelf title. I think for something as prominent as a footer of a shelf on the home page, we'd want it to be as correct as possible.

What do you think @jvillalobos?

[jvillalobos]

Are you saying that it isn't possible for localizers to change the position of the title placeholder in "See more <title>"? The title always needs to come last?

[bobsilverberg]

I've somehow lost my mind. Forgive me, and ignore me. We can totally make it work with i18n, and we do it all the time. I don't know what I was thinking.

[ioanarusiczki]

@eviljeff
I enabled 3 shelves from the admin which are present right now on AMO dev homepage.

The v5, shelves API for title and footer_text:

• without ?lang specified the strings are returned into "en-US"
• with ?lang specified as parameter, lang=it or lang=de I get the en-US string( it's _default), with "it" or "de": null. ( the frontend right now has translations in "it" or "de" from what I see, also primary "description" or secondary "headline" are translated in "it" or "de" in this API). Is this correct?
• with accept-lang other than en-US, I tested with "it" and "de", the strings are returned into "en-US".
• unsupported or invalid ?lang returns "en-US", "eu":null, "_default":en-US.

[ioanarusiczki]

@eviljeff I forgot to add that a request for https://addons-dev.allizom.org/api/v5/shelves/editorial/ returns the list of all shelves added into the admin module providing information about their "title" and "footer_text".