Skip to content

[i18n] Offer some indication when a fallback page is being viewed? #5871

Open
@chalin

Description

@chalin

Here is part of a discussion from #otel-docs-localization. @EzzioMoreira wrote:

Hello, I noticed something strange with the concepts/instrumentation/zero-code doc. When I choose a different language in the opentelemetry documentation the zero-code page is not translated to the chosen language.
The PT team translated this page:: https://github.com/open-telemetry/opentelemetry.io/blob/main/content/pt/docs/concepts/instrumentation/zero-code.md

Here's my (@chalin) response:

Hi @Ezzio Moreira - the website docs are setup so that that each language shows the entire set of doc pages. When a page localization does not exist, Hugo uses the English version as a “fallback”.

This provides, in my opinion, for a smoother user experience where a reader can choose to never leaves their locale pages, and they get to seamlessly see those (sporadic) pages that have been translated.

The alternative is to have (large) page gaps and holes in the locale’s docs, and force the user to “leave” their locale docs and to enter the English locale. But then it is becomes more of a challenge for the reader to figure out which pages are available in the reader’s originally intended locale (they have to consult the language dropdown for each page). In the current scheme, if the page is translated, then it simply is shown as is.

I suspect that @EzzioMoreira's question will pop up again, and so it might be worth considering ways to make this clearer for site readers, though I'm not entirely convinced that it's worth the effort given that it is in a sense obvious when a page hasn't been translated. (Of course, the doubt that arises, as it did for @EzzioMoreira, is whether this is a bug or a feature.) In any case, I'm creating this issue as a place to discuss options, and track any implemented solution.

One rather radical solution would be to drop fallback pages. From a usability point of view, I don't think that that is the best solution, but I'm willing to entertain it.

Another might be to mark fallback page titles in a special way in all or some of the following places:

  • The locale/language drop-down menu
  • The page title
  • The linkTitle (hence the left-nav) page title

Metadata

Metadata

Assignees

No one assigned

    Labels

    discussionInput from everyone is helpful to drive this forwardi18nInternationalization and localization

    Type

    No type

    Projects

    • Status

      No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions