cncf / cncf/techdocs

Create docs localization guide

Open
#153 2 comments 2 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
56
Forks
29
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.