From a738df904f2a0e8f3fd1e69a7015b2cea74c96b4 Mon Sep 17 00:00:00 2001 From: Augustin Mauroy Date: Sun, 22 Dec 2024 16:19:22 +0100 Subject: [PATCH 1/5] chore: document what we want/wan't translate --- TRANSLATION.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/TRANSLATION.md b/TRANSLATION.md index fa36471837cc6..3232193bc6144 100644 --- a/TRANSLATION.md +++ b/TRANSLATION.md @@ -96,3 +96,28 @@ Translations are synced between Crowdin and the repository via GitHub Actions. - Via a cron schedule, and as needed manually by a collaborator, we download completed translations. Incoming translations are linted to ensure they come from crowdin, and are also formatted to adhere to our project settings. + +## Why We Translate This section and Not this Section + +> First what we mean by "section" is a part of the website. It's an collection of pages that are related to each other. For example, the "Learn" section is a collection of pages that are related to learning/discovering Node.js. + +Here we only talk about md/mdx file. The translation of components is covered by a JSON dictionary, so not an issue at all. + +We have theses sections on the website: + +- Learn +- About +- Download +- Blog + +### Sections that are translated + +- **About**: This section is translated because it contains information about the Node.js project, its governance. There are no technical terms that are hard to translate. +- **Download**: This section is translated because it contains information about how to download Node.js. And it's really important that everyone can understand how to download Node.js. + +- **Landing page**: The landing page is translated because it's the first page that people see when they visit the website. It's important that everyone can understand what Node.js is and what it can do. + +### Sections that are not translated + +- **Blog**: The blog is not translated because it's not useful to translate blog posts. Most of blog are release notes, and it's not useful to translate them. +- **Learn**: The learn section is not translated because it contains technical terms that are hard to translate. Plus, we don't have the ability to trust the quality of the translations. It's better to have the content in English than to have bad translations. If you want to have more information read [this message](https://github.com/nodejs/nodejs.org/issues/6429#issuecomment-2558265376) that summarizes whole reasons. From 6625089d9f975e694874f2daca7e220c2d8fa799 Mon Sep 17 00:00:00 2001 From: Augustin Mauroy Date: Sun, 22 Dec 2024 16:22:38 +0100 Subject: [PATCH 2/5] Fix: typo Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Augustin Mauroy --- TRANSLATION.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/TRANSLATION.md b/TRANSLATION.md index 3232193bc6144..51a84de5b19c6 100644 --- a/TRANSLATION.md +++ b/TRANSLATION.md @@ -99,11 +99,11 @@ Incoming translations are linted to ensure they come from crowdin, and are also ## Why We Translate This section and Not this Section -> First what we mean by "section" is a part of the website. It's an collection of pages that are related to each other. For example, the "Learn" section is a collection of pages that are related to learning/discovering Node.js. +> First what we mean by "section" is a part of the website. It's a collection of pages that are related to each other. For example, the "Learn" section is a collection of pages that are related to learning/discovering Node.js. Here we only talk about md/mdx file. The translation of components is covered by a JSON dictionary, so not an issue at all. -We have theses sections on the website: +We have these sections on the website: - Learn - About @@ -119,5 +119,5 @@ We have theses sections on the website: ### Sections that are not translated -- **Blog**: The blog is not translated because it's not useful to translate blog posts. Most of blog are release notes, and it's not useful to translate them. +- **Blog**: The blog is not translated because it's not useful to translate blog posts. Most of the blog posts are release notes, and it's not useful to translate them. - **Learn**: The learn section is not translated because it contains technical terms that are hard to translate. Plus, we don't have the ability to trust the quality of the translations. It's better to have the content in English than to have bad translations. If you want to have more information read [this message](https://github.com/nodejs/nodejs.org/issues/6429#issuecomment-2558265376) that summarizes whole reasons. From 2101523850479e6e10144a639363dc6712e955ce Mon Sep 17 00:00:00 2001 From: Augustin Mauroy Date: Mon, 23 Dec 2024 23:05:36 +0100 Subject: [PATCH 3/5] Apply suggestions from code review Co-authored-by: Brian Muenzenmeyer Signed-off-by: Augustin Mauroy --- TRANSLATION.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/TRANSLATION.md b/TRANSLATION.md index 51a84de5b19c6..22cb2ba74f44d 100644 --- a/TRANSLATION.md +++ b/TRANSLATION.md @@ -97,27 +97,29 @@ Translations are synced between Crowdin and the repository via GitHub Actions. Incoming translations are linted to ensure they come from crowdin, and are also formatted to adhere to our project settings. -## Why We Translate This section and Not this Section +## Why We Translate This section and Not That Section -> First what we mean by "section" is a part of the website. It's a collection of pages that are related to each other. For example, the "Learn" section is a collection of pages that are related to learning/discovering Node.js. +> First, what we mean by "section" is a part of the website. It's a collection of pages that are related to each other. They often correspond to the top-navigation of the site. For example, the "Learn" section is a collection of pages that are related to learning/discovering Node.js. -Here we only talk about md/mdx file. The translation of components is covered by a JSON dictionary, so not an issue at all. +Here we only talk about md/mdx files. The translation of React components is covered by a JSON dictionary and not covered here. We have these sections on the website: +- Home page - Learn - About - Download - Blog +- Docs (not this codebase at all) ### Sections that are translated - **About**: This section is translated because it contains information about the Node.js project, its governance. There are no technical terms that are hard to translate. - **Download**: This section is translated because it contains information about how to download Node.js. And it's really important that everyone can understand how to download Node.js. - -- **Landing page**: The landing page is translated because it's the first page that people see when they visit the website. It's important that everyone can understand what Node.js is and what it can do. +- **Home page**: The landing page is translated because it's the first page that people see when they visit the website. It's important that everyone can understand what Node.js is and what it can do. ### Sections that are not translated +- **Docs**: The API docs are too expansive, and versioned, to be translated. - **Blog**: The blog is not translated because it's not useful to translate blog posts. Most of the blog posts are release notes, and it's not useful to translate them. - **Learn**: The learn section is not translated because it contains technical terms that are hard to translate. Plus, we don't have the ability to trust the quality of the translations. It's better to have the content in English than to have bad translations. If you want to have more information read [this message](https://github.com/nodejs/nodejs.org/issues/6429#issuecomment-2558265376) that summarizes whole reasons. From 2b6db3a06a77ff62913f1ad6466983e67ec4324f Mon Sep 17 00:00:00 2001 From: Augustin Mauroy Date: Mon, 23 Dec 2024 23:08:08 +0100 Subject: [PATCH 4/5] update order --- TRANSLATION.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/TRANSLATION.md b/TRANSLATION.md index 22cb2ba74f44d..f166a9993d50f 100644 --- a/TRANSLATION.md +++ b/TRANSLATION.md @@ -114,12 +114,12 @@ We have these sections on the website: ### Sections that are translated +- **Home page**: The landing page is translated because it's the first page that people see when they visit the website. It's important that everyone can understand what Node.js is and what it can do. - **About**: This section is translated because it contains information about the Node.js project, its governance. There are no technical terms that are hard to translate. - **Download**: This section is translated because it contains information about how to download Node.js. And it's really important that everyone can understand how to download Node.js. -- **Home page**: The landing page is translated because it's the first page that people see when they visit the website. It's important that everyone can understand what Node.js is and what it can do. ### Sections that are not translated -- **Docs**: The API docs are too expansive, and versioned, to be translated. -- **Blog**: The blog is not translated because it's not useful to translate blog posts. Most of the blog posts are release notes, and it's not useful to translate them. - **Learn**: The learn section is not translated because it contains technical terms that are hard to translate. Plus, we don't have the ability to trust the quality of the translations. It's better to have the content in English than to have bad translations. If you want to have more information read [this message](https://github.com/nodejs/nodejs.org/issues/6429#issuecomment-2558265376) that summarizes whole reasons. +- **Blog**: The blog is not translated because it's not useful to translate blog posts. Most of the blog posts are release notes, and it's not useful to translate them. +- **Docs**: The API docs are too expansive, and versioned, to be translated. From 81ddce44680ce2f51768845f52ae9ec72d4a98aa Mon Sep 17 00:00:00 2001 From: Augustin Mauroy Date: Wed, 25 Dec 2024 15:13:52 +0100 Subject: [PATCH 5/5] inclue tsc mention Co-authored-by: Brian Muenzenmeyer Signed-off-by: Augustin Mauroy --- TRANSLATION.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TRANSLATION.md b/TRANSLATION.md index f166a9993d50f..32f428a95d81e 100644 --- a/TRANSLATION.md +++ b/TRANSLATION.md @@ -120,6 +120,6 @@ We have these sections on the website: ### Sections that are not translated -- **Learn**: The learn section is not translated because it contains technical terms that are hard to translate. Plus, we don't have the ability to trust the quality of the translations. It's better to have the content in English than to have bad translations. If you want to have more information read [this message](https://github.com/nodejs/nodejs.org/issues/6429#issuecomment-2558265376) that summarizes whole reasons. +- **Learn**: Per TSC consensus, the learn section is not translated. It contains technical terms that are hard to translate. Maintainers do not have the ability or bandwidth to ensure quality. It's better to have the content in English than to have bad translations. If you want to have more information read [this message](https://github.com/nodejs/nodejs.org/issues/6429#issuecomment-2558265376) that further explains. - **Blog**: The blog is not translated because it's not useful to translate blog posts. Most of the blog posts are release notes, and it's not useful to translate them. - **Docs**: The API docs are too expansive, and versioned, to be translated.