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.

Sign up for GitHub

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

chore: document what we will/won’t translate #7350

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+27 −0
Open

chore: document what we will/won’t translate #7350

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a738df9
chore: document what we want/wan't translate
AugustinMauroy Dec 22, 2024
6625089
Fix: typo
AugustinMauroy Dec 22, 2024
2101523
Apply suggestions from code review
AugustinMauroy Dec 23, 2024
2b6db3a
update order
AugustinMauroy Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions TRANSLATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,3 +96,30 @@ 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 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. 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 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
AugustinMauroy marked this conversation as resolved.
Show resolved Hide resolved
- Docs (not this codebase at all)

### 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.

AugustinMauroy marked this conversation as resolved.
Show resolved Hide resolved
### 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.
- **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.
Loading