microsoft / microsoft/TypeScript-Website-Localizations

Translation Recommendations

Aperta
#21 0 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
JavaScript
Stelle
124
Fork
128
Merge medio
22h 34m
PR unite (30g)
1

Descrizione

How To Contribute

  1. Join the TypeScript Discord - come say hi the ts-web-translate

  2. Follow the instructions on the README of this repo to get set up.

All Markdown Docs

Each translatable page is a unique markdown file which can be uniquely handled per language. Any markdown file not found will be replaced with English when not present.

Website

The website supports localization via React-intl, as of today only the navigation bar it translatable, but with time this will grow. The infra just came in with https://github.com/microsoft/TypeScript-Website/pull/180

There are a series of keys and values for each language, with a fallback to English if you miss something. The TypeScript compiler will keep it all in check.

Playground

You can cover the examples in the dropdown in the playground (and in the site footer on desktops.) Full docs here

  • Make a subfolder with the code of the language in the copy folder of the 'playground-examples'
  • Ensure the filename are the same as English, (you can provide a different title via the JSON headers in the ts/js files)
  • Check out this folder
  • Ensure the filename is the same (we can provide a different title via the YML headers in the markdown files)

Recommendations

I'm pretty new to the translation game, but here's some notes from working with people so far on how translations can culturally work in the TS website.

Translate code to be a cultural fit. E.g.
const helloWorld = "Hi" 

to

const olaMundo = "Olá`
Translate names in example
const user =  { name: "John" }

to

const usar =  { name: "João" }

Note: we aim to have a diverse set of nationalities and genders in our examples, so I'd recommend not changing all of them, but try keep it feeling like it was written with that in mind also.

Translate Technical Terms, but keep English around

This one is nuanced, but a term like Mapped Type is the name for this:

type MyPartialType<Type> = {
  // For every existing property inside the type of Type
  // convert it to be a ?: version
  [Property in keyof Type]?: Type[Property];
};

So, if you translate it to "mapeada type", then provide a reference to the original name the first time it is used: "mapeada type (Mapped Type em inglês)" so that readers can know how to find the English resources on a topic.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dal README del repository e dalle directory collegate markdown documentation, playground-examples e tsconfig-reference. Esamina come viene attualmente utilizzata la localizzazione di React-intl per la barra di navigazione e come sono organizzati gli esempi tradotti. L’issue non identifica un file di destinazione né criteri di accettazione, quindi per completarla sarebbe necessario definire l’ambito e documentare le raccomandazioni di traduzione concordate.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
react, typescript
Ambito
content, documentation, localization
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.