open-feature / open-feature/openfeature.dev

Localization support for OpenFeature documentation

Open
#1,269 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
65
Forks
117
Avg merge
1d 11h
Merged PRs (30d)
41

Description

Hi, OpenFeature team! 👋🏼

Documentation is the backbone of any project, and it’s often the first touchpoint for new contributors and adopters. Having docs available in multiple languages lowers the entry barrier, makes the project more inclusive, and helps adoption in regions where English isn’t the primary language.

As an active contributor to the OpenTelemetry project for over a year, I’ve seen how impactful this process can be. OpenTelemetry now supports several localizations on its docs, which has made it easier for contributors and users in those communities to participate and learn more about the project.

Since I couldn't find any guidance regarding localization in the OpenFeature docs, I'm opening this issue that could serve as a starting point for discussion. The main proposals are:

  1. Explore whether the project is open to supporting multiple languages.
  2. If so, add localization support to the OpenFeature documentation.
  3. Start with the Portuguese localization as a pilot, with potential contributors, and expand gradually.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points and says that localization guidance is absent from the OpenFeature docs. Start by reviewing the existing documentation structure and discussing whether multilingual support is wanted; completion would require an agreed localization approach and a defined Portuguese pilot scope.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, localization
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.