cncf / cncf/techdocs

Create docs localization guide

Aperta
#153 2 commenti 2 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
TypeScript
Stelle
56
Fork
29
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

We should create a guide that talks about localization best practices and recommendations for CNCF projects looking to add localization to their projects.

This guide should be added to https://github.com/cncf/techdocs/tree/main/docs/localization.

Ideas of areas that this guide should cover:
* What is localization and why should you do it
* Considerations to think about before starting localization (community size, documentation maturity,...). Is localization right for your project?
* Finding and building community for localization teams
* Tool changes needed for localization, ie. make sure your website handles localized content
* localization process best practices

Research:
* Are there any available guides we should reference or incorporate into a CNCF guide?
* Identify if any CNCF projects are doing localization, and see if they have any best practices to share. Kubernetes is probably the furthest along in this journey, but we should see if there are other projects to talk to

The intention of this issue is to create a guide for localizing docs, but we should also decide if we want to include any recommendations for localizing parts of the codebase, like UI or CLI. Something might overlap, but we should be mindful of an potential differences.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Inizia esaminando la directory esistente docs/localization nel repository techdocs. Analizza le guide di localizzazione esistenti e i progetti CNCF, incluso Kubernetes, quindi definisci se la guida copre solo la documentazione oppure anche il codice UI e CLI; il lavoro è completato quando è disponibile una guida completa che copre le aree di best practice e i riferimenti elencati.

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

Valutazione

Ambito
documentation, localization
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.