search

open-telemetry / opentelemetry.io

The OpenTelemetry website and documentation
https://opentelemetry.io
Creative Commons Attribution 4.0 International
514 stars 1.1k forks source link

Add Spanish (`es`) version of website pages #4887

Closed krol3 closed 1 week ago

krol3 commented 1 month ago

Following the samples of Japanese and Portuguese version of websites. We would like to support the Spanish website page and translations for the docs.

We'll use this issue to track the added support of a sp (Spanis) localization.

Tasks

References

cc: @chalin

svrnm commented 1 month ago

Hey @krol3,

thank you for raising this issue! Having a spanish translation of the OpenTelemetry website is something we are looking forward to have, so thanks for offering your help!

Localization & Internationalization is still a new topic to use, so we are at the moment intentionally slowing down the onboarding for new languages, to avoid overburdening maintainers and to avoid you having a bad experience. I say this upfront because it may take a few weeks until we can successfully add a new language.

Saying all that, here are the next steps:

svrnm commented 1 month ago

@krol3 @theletterf based on a discussion during the SIG meeting I updated the issue description, that as a first step we need to agree on the Spanish Variety

chalin commented 1 month ago

As discuss during the (end of the) Comms meeting: which ever Spanish regional variant @krol3 et al. decide upon, that will become the defacto/default region for the OTel docs. We'll eventually need to choose a language code (see below for choices), but regardless, the content subfolder will be es.

Here are some of the most commonly used Spanish language codes that start with es-:

Maybe either es-419 or es-ES, WDYT?

krol3 commented 1 month ago

As discuss during the (end of the) Comms meeting: which ever Spanish regional variant @krol3 et al. decide upon, that will become the defacto/default region for the OTel docs. We'll eventually need to choose a language code (see below for choices), but regardless, the content subfolder will be es.

Here are some of the most commonly used Spanish language codes that start with es-:

  • es-ES: Spanish (Spain)
  • es-MX: Spanish (Mexico)
  • es-AR: Spanish (Argentina)
  • es-CO: Spanish (Colombia)
  • es-PE: Spanish (Peru)
  • es-VE: Spanish (Venezuela)
  • es-CL: Spanish (Chile)
  • es-419: Spanish (Latin America and the Caribbean)

Maybe either es-419 or es-ES, WDYT?

Following the kubernetes documentation spanish translation, we don't use a local/region/country variant in spanish. We collaborate with each other to translate to spanish (es).

theletterf commented 1 month ago

+1 to what @krol3 said. If we can just go with the root (es) I'd do that.

theletterf commented 1 month ago

@krol3 For the priority pages, I was thinking of the same list as pt-BR, plus perhaps the contribution guide. What do you think? https://github.com/open-telemetry/opentelemetry.io/issues/4922

svrnm commented 1 month ago

@theletterf based on our conversation on Monday, I was under the assumption that while we are going to use es we still need to agree on the defacto variant that we use (similar to what we do with pt and zh).

theletterf commented 1 month ago

@svrnm I've no strong feelings about it at this stage. I'd go with es-ES, but I'm guessing here that K8s chose to go with just es to foster contributions and avoid conflicts with lexical variants. FWIW, their site reads as es-ES; I doubt regional vocabulary from all around the Hispanosphere will ever make it to the docs — and we'll edit it if it does.

theletterf commented 1 month ago

lang:es label created.

theletterf commented 1 month ago

Opened https://github.com/open-telemetry/community/issues/2262 to request the creation of the groups.

theletterf commented 1 month ago

Created #4989

krol3 commented 1 month ago

Hey @krol3,

thank you for raising this issue! Having a spanish translation of the OpenTelemetry website is something we are looking forward to have, so thanks for offering your help!

Localization & Internationalization is still a new topic to use, so we are at the moment intentionally slowing down the onboarding for new languages, to avoid overburdening maintainers and to avoid you having a bad experience. I say this upfront because it may take a few weeks until we can successfully add a new language.

Saying all that, here are the next steps:

  • Find at least 1 more (ideally 2) people that are willing to help with the translation, such that someone who does the translation always has a person that can do the review.
  • Create a PR for the homepage (and nothing more), following the example of other languages, e.g. pt. Leave editing the hugo.yml to us, we will update your PR accordingly
  • Wait for this PR to be merged (this is where we might put a delay)
  • We will after the PR has been merged setup the rest of the language (adding labels, groups, etc.)

Hi @svrnm , I would like to propose to help in the Spanish translations to @electrocucaracha, @ramrodo. They're contributors and maintainers in the k8s website. I know more people will be interesting to help too.

krol3 commented 1 month ago

Here are some of the most commonly used Spanish language codes that start with es-:

  • es-ES: Spanish (Spain)
  • es-MX: Spanish (Mexico)
  • es-AR: Spanish (Argentina)
  • es-CO: Spanish (Colombia)
  • es-PE: Spanish (Peru)
  • es-VE: Spanish (Venezuela)
  • es-CL: Spanish (Chile)
  • es-419: Spanish (Latin America and the Caribbean)

Maybe either es-419 or es-ES, WDYT?

hi @theletterf yeah I will prefer just "ES" for the code spanish language, and don't use the region or country. For example in the kubernetes spanish documentation we use "ES". The contributors are from Guatemala, El Savaldor, Peru, Mexico, etc. We all colaborate to the ES language.

ramrodo commented 1 month ago

I agree with @krol3 , at the official Kubernetes documentation we use es to avoid region word conflicts and variants. The es dictionary is valid and available at cspell:

https://github.com/streetsidesoftware/cspell/blame/main/packages/cspell-trie-lib/src/lib/models/locale/knownLocales.ts#L197

chalin commented 1 month ago

Thanks @ramrodo for the reference into the cSpell code. IMHO, that says that es is recognized as a valid language code, but that doesn't give us an es dictionary. I'm not aware of an es dictionary, only an es-ES one via:

In summary, we can adopt es as the language code used as the folder name below content, but if we enable spell checking, then either you'll need to supply a "generic" es dictionary, or we'll go with the es_ES one.

theletterf commented 1 month ago

@svrnm Could component owners be updated without waiting for the OTel community issue to be solved?

svrnm commented 1 month ago

@svrnm Could component owners be updated without waiting for the OTel community issue to be solved?

Without the team being in place the process would run into an error everytime it runs. I am annoying people already to create the teams.

theletterf commented 2 weeks ago

@krol3 All initial actions completed. I'd close this task and follow with PRs.

Example: https://github.com/open-telemetry/opentelemetry.io/issues/4922