Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support Localization of the website #303

Open
8 tasks
xmulligan opened this issue Jun 28, 2023 · 2 comments
Open
8 tasks

Support Localization of the website #303

xmulligan opened this issue Jun 28, 2023 · 2 comments

Comments

@xmulligan
Copy link
Member

Many people like to read website in their mother tongue. For example, in Kubernetes documentation, only 50% of the page views are in English. Supporting localization of the Cilium website will help grow our community and provide good entry points for new contributors from different backgrounds to the Cilium community.

Describe the feature you'd like

To help people start a new localization, they need:

  1. Community guidelines on how to start a localization
  2. Technical tutorials how to create and build the localization
  3. Minimum requirements for having a localization be part of the website
  4. Build fall back into the docs for when a page hasn't been translated

The Kubernetes project has a good framework that we could follow:

See https://kubernetes.io/docs/contribute/localization/. Some key parts would be:
a) If you want the Kubernetes documentation localized into a new language, here's what you need to do. Because contributors can't approve their own pull requests, you need at least two contributors to begin a localization. All localization teams must be self-sustaining. The Kubernetes website is happy to host your work, but it's up to you to translate it and keep existing localized content current.
b) Localizing all of the Kubernetes documentation is an enormous task. It's okay to start small and expand over time. When you start a new localization, you must localize all the minimum required content before the Kubernetes project can publish your changes to the live website.
c) Localizing the README and CoC

Create a README (Kubernetes example) that tells people how to build, test, and troubleshoot the documentation.

Decide upon a set of minimum required content for localized documentation to be mereged into master. I would suggest

  • Use cases
  • get started
  • get involved
  • get help
  • events
  • blog
  • enterprise
  • newsletter

Make sure the docs fall back to English rather than 404 when a page has not been translated yet.

Reference

These two talks from Zach Corleissen are also helpful to understand how Kubernetes did it:

Multilingual Kubernetes: The kubernetes.io stack, how we got there, and what it took to get there

Localize your open source documentation: a Kubernetes case study

@zilmarr
Copy link

zilmarr commented Jan 26, 2024

I'd love to work on pt-br localization.

I've made some contributions to Kubernetes localization and I believe it's a good framework.

About the minimum required content, maybe we should look for the most accessed pages, aside from those you've mentioned.

@xmulligan
Copy link
Member Author

Sorry for taking so long to get back to you 😓

Are you interested in helping make the framework or do you just want to do the localization?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants