Help us translate the BeAPI website

[nobu-sh]

Last updated: 4/2/2021

Help us translate the BeAPI website

BeAPIs website uses a documentation framework called Docusaurus.
Docusaurus v2 is completely i18n localization ready. With that being said we want to translate BeAPIs website for
our non fluent English users.

Roadmap before translation ready

• Possible CLI translations via os locale ¹
• Register BeAPI for Crowdin open-source plan ²
• Integrate Crowdin with Docusaurus i18n ³
• Spend countless hours blacklisting mdx keys in Crowdin ;-;
• Reach out to other communities to help translate :)

Translation process

• Optionally get familiar with the Docusaurus i18n support
• Ensure your language is also translated for the CLI (Prioritize CLI translations first)
• Sign-up on Crowdin and join the BeAPI project
• Get familiar with the Crowdin translation UI, as you will need to use it to translate JSON and Markdown files
• Ask for your locale to be enabled on Crowdin (if not already enabled)
• Translate the content

More info will be made available once roadmap is complete!

Footnotes

1. Example of getting OS locale through node:

   const env = process.env;
   const language = env.LANG || env.LANGUAGE || env.LC_ALL || env.LC_MESSAGES;
   

   ↩

2. Crowdin offers a free plan for open source projects, read more here. ↩

3. Implementation documentation located here. ↩

[github-actions]

Issue activity has been deciphered as stale. Marking issue with stale label