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

docs: update i18n/README.md #531

Merged
merged 1 commit into from
Mar 4, 2024
Merged

docs: update i18n/README.md #531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ build/
content/
i18n/
!i18n/en/
!i18n/README.md
docs/v**
9 changes: 5 additions & 4 deletions i18n/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@ Some of the files that are generated are `code.json`, `navbar.json`,
For the website's source language (`en-US`), these JSON files are **not**
used by Docusaurus. Rather, they serve as source files for our
[Crowdin](https://crowdin.com/project/electron) internationalization (i18n)
workflow. The [`electron/i18n`](https://github.com/electron/i18n) repository
periodically updates these source strings on Crowdin via
[GitHub Actions](https://github.com/electron/i18n/actions/workflows/schedule-update-source-content.yml).
workflow.

To keep everything in sync, there is a pre-commit hook that automatically
deletes and creates again the `en-US` folder and its contents when
`docusaurus.config.js` or `sidebars.js` are modified.
The script the hook invokes is in `/scripts/update-l10n-sources.js`.
The script the hook invokes is in `/scripts/update-l10n-sources.ts`.

For details on how to contribute to the i18n of the Electron docs, please
see [i18n.md](../i18n.md).