cncf
Create docs localization guide
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.
Hello @a-mccarthy @kumarankit999 cc @nate-double-u @seokho-son @CathPag
I am a member of the Japanese localization team. Our Japanese l10n team is very interested in this issue.
FYI. https://cloud-native.slack.com/archives/C02N2RGFXDF/p1716276741343179
Our project started with the cncf/glossary, and now we are working on l10n for other TAGs and WGs (for example, tag-runtime#145, tag-app-delivery#521). Through this, we have realized the importance of more general l10n documentation (and we think this issue is the best place to discuss it! Thank you @nate-double-u ).
I personally (note that this is my personal opinion and not that of the entire team) think that a discussion about the l10n process is particularly necessary. I think the cncf/glossary is the furthest project along in this journey in terms of l10n within the cncf projects and serves as the most useful reference to start with. In the cncf/glossary, each l10n team has its own branch, and sync-up with the main branch is handled by maintainers. This is an excellent method, but does it place a bit heavy tasks on the maintainers? The approach used by k/website also seems excellent, but introducing prow would be a challenging path.
