From 4dbe434ce6e8dda5b6000a5f6653f048aa9731b2 Mon Sep 17 00:00:00 2001 From: Rotem Tamir Date: Mon, 29 Mar 2021 16:55:10 +0300 Subject: [PATCH] doc/md - contributing translations guide --- doc/md/translations.md | 27 +++++++++++++++++++++++++++ doc/website/sidebars.js | 1 + 2 files changed, 28 insertions(+) create mode 100644 doc/md/translations.md diff --git a/doc/md/translations.md b/doc/md/translations.md new file mode 100644 index 000000000..30afa86e6 --- /dev/null +++ b/doc/md/translations.md @@ -0,0 +1,27 @@ +--- +id: translations +title: Translations +--- + +## Introduction + +To make Ent more accessible to native speakers of other languages we have started a translation initiative. +Our goal is to make all documents in this website available in both Chinese and Japanese. To facilitate the +translation, approval and deployment process we have integrated this website with [Crowdin](https://crowdin.com). + +## Contributing + +1. Sign up as a translator on our [Crowdin project](https://crwd.in/ent) +2. After registration and sign up, go to our [Project Page](https://crowdin.com/project/ent) +3. Pick the language you would like to translate a document into. +4. Pick the document you want to translate: + * All Docs are under the `md/` folder + * Blog Posts are under `website/blog` + * Website UI components are under `website/i18n` +5. For more information on using the Crowdin UI, please read the [Online Editor documentation](https://support.crowdin.com/online-editor/). +6. Your suggestions will be reviewed by a proof-reader, and once approved they will be +included in the next website deployment. + +## Joining as a Proof-reader +If you would like to contribute in a more permanent way and become a proof-reader +for one of the languages, please ping us via the slack channel. \ No newline at end of file diff --git a/doc/website/sidebars.js b/doc/website/sidebars.js index 0630bfe3a..43c2be07c 100755 --- a/doc/website/sidebars.js +++ b/doc/website/sidebars.js @@ -57,6 +57,7 @@ module.exports = { 'testing', 'faq', 'feature-flags', + 'translations' ], collapsed: false, },