mirror of
https://github.com/freeCodeCamp/freeCodeCamp.git
synced 2026-01-06 06:01:31 -05:00
chore(i18n,docs): processed translations (#47428)
This commit is contained in:
camperbot
@@ -19,7 +19,6 @@
|
||||
- [Work on documentation](how-to-work-on-the-docs-theme.md)
|
||||
- [Work on the component library](how-to-work-on-the-component-library.md)
|
||||
- **Additional Guides**
|
||||
- [Test translations locally](how-to-test-translations-locally.md)
|
||||
- [Understand the curriculum file structure](curriculum-file-structure.md)
|
||||
- [Debug outgoing emails locally](how-to-catch-outgoing-emails-locally.md)
|
||||
- [Set up freeCodeCamp on Windows (WSL)](how-to-setup-wsl.md)
|
||||
@@ -32,6 +31,7 @@
|
||||
- [Language Lead Handbook](language-lead-handbook.md)
|
||||
- [DevOps Handbook](devops.md)
|
||||
- [Courses VSCode Extension](courses-vscode-extension.md)
|
||||
- [Enable New Language](how-to-enable-new-languages.md)
|
||||
|
||||
---
|
||||
|
||||
|
||||
279
docs/i18n/chinese-traditional/how-to-enable-new-languages.md
Normal file
279
docs/i18n/chinese-traditional/how-to-enable-new-languages.md
Normal file
@@ -0,0 +1,279 @@
|
||||
# Deploying New Languages on `/learn`
|
||||
|
||||
Before you can release a new language, you will need to allow the languages to download from Crowdin.
|
||||
|
||||
## Updating Crowdin Settings
|
||||
|
||||
In the `Curriculum` and `Learn UI` projects, you will need to select `Project Settings` from the sidebar. Then scroll down to `Language Mapping`, where you will see an option to add custom language codes. Add a new entry for the language you are releasing, selecting `language` as the `Placeholder` value, and entering a URL-friendly lower-case spelling of your language's name for the `Custom code`. If you aren't sure what to use, reach out in our contributor chat and we will assist you.
|
||||
|
||||
## Updating Workflows
|
||||
|
||||
You will need to add a step to the `crowdin-download.client-ui.yml` and `crowdin-download.curriculum.yml`. The step for these will be the same. For example, if you want to enable Dothraki downloads:
|
||||
|
||||
```yml
|
||||
##### Download Dothraki #####
|
||||
- name: Crowdin Download Dothraki Translations
|
||||
uses: crowdin/github-action@master
|
||||
# options: https://github.com/crowdin/github-action/blob/master/action.yml
|
||||
with:
|
||||
# uploads
|
||||
upload_sources: false
|
||||
upload_translations: false
|
||||
auto_approve_imported: false
|
||||
import_eq_suggestions: false
|
||||
|
||||
# downloads
|
||||
download_translations: true
|
||||
download_language: mis
|
||||
skip_untranslated_files: false
|
||||
export_only_approved: true
|
||||
|
||||
push_translations: false
|
||||
|
||||
# pull-request
|
||||
create_pull_request: false
|
||||
|
||||
# global options
|
||||
config: './crowdin-config.yml'
|
||||
base_url: ${{ secrets.CROWDIN_BASE_URL_FCC }}
|
||||
|
||||
# Uncomment below to debug
|
||||
# dryrun_action: true
|
||||
```
|
||||
|
||||
Note that the `download_language` key needs to be set to the language code displayed on Crowdin.
|
||||
|
||||
## Enabling a Language
|
||||
|
||||
> [!NOTE] The above section with updating the workflows should be completed before proceeding - these need to be done in separate steps or the builds will fail.
|
||||
|
||||
There are a few steps to take in order to allow the codebase to build in your desired language.
|
||||
|
||||
First, visit the `config/i18n/all-langs.ts` file to add the language to the available languages list and configure the values. There are several objects here.
|
||||
|
||||
- `availableLangs`: For both the `client` and `curriculum` arrays, add the text name of the language. This is the value that will be used in the `.env` file later.
|
||||
- `auditedCerts`: Add the text name of the language as the _key_, and add an array of `SuperBlocks.{cert}` variables as the _value_. This tells the client which certifications are fully translated.
|
||||
- `i18nextCodes`: These are the ISO language codes for each language. You will need to add the appropriate ISO code for the language you are enabling. These do need to be unique for each language.
|
||||
- `LangNames`: These are the display names for the language selector in the navigation menu.
|
||||
- `LangCodes`: These are the language codes used for formatting dates and numbers. These should be Unicode CLDR codes instead of ISO codes.
|
||||
- `hiddenLangs`: These languages will not be displayed in the navigation menu. This is used for languages that are not yet ready for release.
|
||||
|
||||
As an example, if you wanted to enable Dothraki as a language, your `all-langs.js` objects should look like this:
|
||||
|
||||
```js
|
||||
export const availableLangs = {
|
||||
client: ['english', 'espanol', 'chinese', 'chinese-traditional', 'dothraki'],
|
||||
curriculum: [
|
||||
'english',
|
||||
'espanol',
|
||||
'chinese',
|
||||
'chinese-traditional',
|
||||
'dothraki'
|
||||
]
|
||||
};
|
||||
|
||||
export const auditedCerts = {
|
||||
espanol: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis
|
||||
],
|
||||
chinese: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis,
|
||||
SuperBlocks.QualityAssurance,
|
||||
SuperBlocks.SciCompPy,
|
||||
SuperBlocks.DataAnalysisPy,
|
||||
SuperBlocks.InfoSec,
|
||||
SuperBlocks.MachineLearningPy
|
||||
],
|
||||
'chinese-traditional': [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis,
|
||||
SuperBlocks.QualityAssurance,
|
||||
SuperBlocks.SciCompPy,
|
||||
SuperBlocks.DataAnalysisPy,
|
||||
SuperBlocks.InfoSec,
|
||||
SuperBlocks.MachineLearningPy
|
||||
],
|
||||
dothraki: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs
|
||||
]
|
||||
};
|
||||
|
||||
export const i18nextCodes = {
|
||||
english: 'en',
|
||||
espanol: 'es',
|
||||
chinese: 'zh',
|
||||
'chinese-traditional': 'zh-Hant',
|
||||
dothraki: 'mis'
|
||||
};
|
||||
|
||||
export enum LangNames = {
|
||||
english: 'English',
|
||||
espanol: 'Español',
|
||||
chinese: '中文（簡體字）',
|
||||
'chinese-traditional': '中文（繁體字）',
|
||||
dothraki: 'Dothraki'
|
||||
};
|
||||
|
||||
export enum LangCodes = {
|
||||
english: 'en-US',
|
||||
espanol: 'es-419',
|
||||
chinese: 'zh',
|
||||
'chinese-traditional': 'zh-Hant',
|
||||
dothraki: 'mis'
|
||||
};
|
||||
|
||||
export const hiddenLangs = ['dothraki'];
|
||||
```
|
||||
|
||||
> [!NOTE] When a language has been set up in the deployment pipeline AND has a public `/news` instance live, it can be removed from the `hiddenLangs` array and be made available to the public.
|
||||
|
||||
Next, open the `client/src/utils/algolia-locale-setup.ts` file. This data is used for the search bar that loads `/news` articles. While it is unlikely that you are going to test this functionality, missing the data for your language can lead to errors when attempting to build the codebase locally.
|
||||
|
||||
Add an object for your language to the `algoliaIndices` object. You should use the the same values as the `english` object for local testing, replacing the `english` key with your language's `availableLangs` value.
|
||||
|
||||
> [!NOTE] If we have already deployed an instance of news in your target language, you can update the values to reflect the live instance. Otherwise, use the English values.
|
||||
|
||||
If you were to add Dothraki:
|
||||
|
||||
```js
|
||||
const algoliaIndices = {
|
||||
english: {
|
||||
name: 'news',
|
||||
searchPage: 'https://www.freecodecamp.org/news/search/'
|
||||
},
|
||||
espanol: {
|
||||
name: 'news-es',
|
||||
searchPage: 'https://www.freecodecamp.org/espanol/news/search/'
|
||||
},
|
||||
chinese: {
|
||||
name: 'news-zh',
|
||||
searchPage: 'https://chinese.freecodecamp.org/news/search/'
|
||||
},
|
||||
'chinese-traditional': {
|
||||
name: 'news-zh',
|
||||
searchPage: 'https://chinese.freecodecamp.org/news/search'
|
||||
},
|
||||
dothraki: {
|
||||
name: 'news',
|
||||
searchPage: 'https://www.freecodecamp.org/news/search/'
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
### Releasing a Superblock
|
||||
|
||||
After a superblock has been fully translated into a language, there are two steps to release it. First add the superblock enum to that language's `auditedCerts` array. So, if you want to release the new Responsive Web Design superblock for Dothraki, the array should look like this:
|
||||
|
||||
```ts
|
||||
export const auditedCerts = {
|
||||
// other languages
|
||||
dothraki: [
|
||||
SuperBlocks.RespWebDesignNew, // the newly translated superblock
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs
|
||||
]
|
||||
};
|
||||
```
|
||||
|
||||
Finally, if the superblock is in a "new" state (that is, replacing a legacy superblock), the `languagesWithAuditedBetaReleases` array should be updated to include the new language like this:
|
||||
|
||||
```ts
|
||||
export const languagesWithAuditedBetaReleases: ['english', 'dothraki'];
|
||||
```
|
||||
|
||||
This will move the new superblock to the correct place in the curriculum map on `/learn`.
|
||||
|
||||
## Enabling Localized Videos
|
||||
|
||||
For the video challenges, you need to change a few things. First add the new locale to the GraphQL query in the `client/src/templates/Challenges/video/Show.tsx` file. For example, adding Dothraki to the query:
|
||||
|
||||
```tsx
|
||||
query VideoChallenge($slug: String!) {
|
||||
challengeNode(fields: { slug: { eq: $slug } }) {
|
||||
videoId
|
||||
videoLocaleIds {
|
||||
espanol
|
||||
italian
|
||||
portuguese
|
||||
dothraki
|
||||
}
|
||||
...
|
||||
```
|
||||
|
||||
Then add an id for the new language to any video challenge in an audited block. For example, if `auditedCerts` in `all-langs.ts` includes `scientific-computing-with-python` for `dothraki`, then you must add a `dothraki` entry in `videoLocaleIds`. The frontmatter should then look like this:
|
||||
|
||||
```yml
|
||||
videoLocaleIds:
|
||||
espanol: 3muQV-Im3Z0
|
||||
italian: hiRTRAqNlpE
|
||||
portuguese: AelGAcoMXbI
|
||||
dothraki: new-id-here
|
||||
dashedName: introduction-why-program
|
||||
---
|
||||
```
|
||||
|
||||
Update the `VideoLocaleIds` interface in `client/src/redux/prop-types` to include the new language.
|
||||
|
||||
```ts
|
||||
export interface VideoLocaleIds {
|
||||
espanol?: string;
|
||||
italian?: string;
|
||||
portuguese?: string;
|
||||
dothraki?: string;
|
||||
}
|
||||
```
|
||||
|
||||
And finally update the challenge schema in `curriculum/schema/challengeSchema.js`.
|
||||
|
||||
```js
|
||||
videoLocaleIds: Joi.when('challengeType', {
|
||||
is: challengeTypes.video,
|
||||
then: Joi.object().keys({
|
||||
espanol: Joi.string(),
|
||||
italian: Joi.string(),
|
||||
portuguese: Joi.string(),
|
||||
dothraki: Joi.string()
|
||||
})
|
||||
}),
|
||||
```
|
||||
|
||||
## Client UI
|
||||
|
||||
You will need to take an additional step to handle the client UI translations.
|
||||
|
||||
The Crowdin workflows will automatically pull down _some_ of the UI translations, but there are a couple of files that need to be moved manually.
|
||||
|
||||
You will want to copy the following files from `/client/i18n/locales/english` to `/client/i18n/locales/<your-language>`, and apply translations as needed:
|
||||
|
||||
- `links.json`
|
||||
- `meta-tags.json`
|
||||
- `motivation.json`
|
||||
- `trending.json`
|
||||
|
||||
## Testing Translations Locally
|
||||
|
||||
If you would like to test translations locally, before adding them to our main repository - skip the Crowdin workflow changes. Follow the steps for enabling a language, then download the translations from Crowdin and load them into your local code.
|
||||
|
||||
Because the language has not been approved for production, our scripts are not automatically downloading the translations yet. Only staff have the access to directly download the translations - you are welcome to reach out to us in our [contributors chat room](https://discord.gg/PRyKn3Vbay), or you can translate the English markdown files locally for testing purposes.
|
||||
|
||||
Once you have the files, you will need to place them in the correct directory. For the curriculum challenges, you should place the certification folders (i.e. `01-responsive-web-design`) within the `curriculum/challenges/{lang}` directory. For our Dothraki translations, this would be `curriculum/challenges/dothraki`. The client translation `.json` files will go in the `client/i18n/locales/{lang}` directory.
|
||||
|
||||
Update your `.env` file to use your new language for `CLIENT_LOCALE` and `CURRICULUM_LOCALE`.
|
||||
|
||||
Once these are in place, you should be able to run `npm run develop` to view your translated version of freeCodeCamp.
|
||||
|
||||
> [!ATTENTION] While you may perform translations locally for the purpose of testing, we remind everyone that translations should _not_ be submitted through GitHub and should only be done through Crowdin. Be sure to reset your local codebase after you are done testing.
|
||||
@@ -65,7 +65,7 @@ This is an example of how part of the `trending.json` file has to look.
|
||||
}
|
||||
```
|
||||
|
||||
You will want to [build the translated client locally](how-to-test-translations-locally.md) to see if the titles have the right length. Each title must stay on a single line and not go to a new line.
|
||||
You will want to [build the translated client locally](how-to-enable-new-languages.md) to see if the titles have the right length. Each title must stay on a single line and not go to a new line.
|
||||
|
||||
### How to update the trending articles in the cdn
|
||||
|
||||
|
||||
@@ -19,7 +19,6 @@
|
||||
- [Work on documentation](how-to-work-on-the-docs-theme.md)
|
||||
- [Work on the component library](how-to-work-on-the-component-library.md)
|
||||
- **Additional Guides**
|
||||
- [Test translations locally](how-to-test-translations-locally.md)
|
||||
- [Understand the curriculum file structure](curriculum-file-structure.md)
|
||||
- [Debug outgoing emails locally](how-to-catch-outgoing-emails-locally.md)
|
||||
- [Set up freeCodeCamp on Windows (WSL)](how-to-setup-wsl.md)
|
||||
@@ -32,6 +31,7 @@
|
||||
- [Language Lead Handbook](language-lead-handbook.md)
|
||||
- [DevOps Handbook](devops.md)
|
||||
- [Courses VSCode Extension](courses-vscode-extension.md)
|
||||
- [Enable New Language](how-to-enable-new-languages.md)
|
||||
|
||||
---
|
||||
|
||||
|
||||
279
docs/i18n/chinese/how-to-enable-new-languages.md
Normal file
279
docs/i18n/chinese/how-to-enable-new-languages.md
Normal file
@@ -0,0 +1,279 @@
|
||||
# Deploying New Languages on `/learn`
|
||||
|
||||
Before you can release a new language, you will need to allow the languages to download from Crowdin.
|
||||
|
||||
## Updating Crowdin Settings
|
||||
|
||||
In the `Curriculum` and `Learn UI` projects, you will need to select `Project Settings` from the sidebar. Then scroll down to `Language Mapping`, where you will see an option to add custom language codes. Add a new entry for the language you are releasing, selecting `language` as the `Placeholder` value, and entering a URL-friendly lower-case spelling of your language's name for the `Custom code`. If you aren't sure what to use, reach out in our contributor chat and we will assist you.
|
||||
|
||||
## Updating Workflows
|
||||
|
||||
You will need to add a step to the `crowdin-download.client-ui.yml` and `crowdin-download.curriculum.yml`. The step for these will be the same. For example, if you want to enable Dothraki downloads:
|
||||
|
||||
```yml
|
||||
##### Download Dothraki #####
|
||||
- name: Crowdin Download Dothraki Translations
|
||||
uses: crowdin/github-action@master
|
||||
# options: https://github.com/crowdin/github-action/blob/master/action.yml
|
||||
with:
|
||||
# uploads
|
||||
upload_sources: false
|
||||
upload_translations: false
|
||||
auto_approve_imported: false
|
||||
import_eq_suggestions: false
|
||||
|
||||
# downloads
|
||||
download_translations: true
|
||||
download_language: mis
|
||||
skip_untranslated_files: false
|
||||
export_only_approved: true
|
||||
|
||||
push_translations: false
|
||||
|
||||
# pull-request
|
||||
create_pull_request: false
|
||||
|
||||
# global options
|
||||
config: './crowdin-config.yml'
|
||||
base_url: ${{ secrets.CROWDIN_BASE_URL_FCC }}
|
||||
|
||||
# Uncomment below to debug
|
||||
# dryrun_action: true
|
||||
```
|
||||
|
||||
Note that the `download_language` key needs to be set to the language code displayed on Crowdin.
|
||||
|
||||
## Enabling a Language
|
||||
|
||||
> [!NOTE] The above section with updating the workflows should be completed before proceeding - these need to be done in separate steps or the builds will fail.
|
||||
|
||||
There are a few steps to take in order to allow the codebase to build in your desired language.
|
||||
|
||||
First, visit the `config/i18n/all-langs.ts` file to add the language to the available languages list and configure the values. There are several objects here.
|
||||
|
||||
- `availableLangs`: For both the `client` and `curriculum` arrays, add the text name of the language. This is the value that will be used in the `.env` file later.
|
||||
- `auditedCerts`: Add the text name of the language as the _key_, and add an array of `SuperBlocks.{cert}` variables as the _value_. This tells the client which certifications are fully translated.
|
||||
- `i18nextCodes`: These are the ISO language codes for each language. You will need to add the appropriate ISO code for the language you are enabling. These do need to be unique for each language.
|
||||
- `LangNames`: These are the display names for the language selector in the navigation menu.
|
||||
- `LangCodes`: These are the language codes used for formatting dates and numbers. These should be Unicode CLDR codes instead of ISO codes.
|
||||
- `hiddenLangs`: These languages will not be displayed in the navigation menu. This is used for languages that are not yet ready for release.
|
||||
|
||||
As an example, if you wanted to enable Dothraki as a language, your `all-langs.js` objects should look like this:
|
||||
|
||||
```js
|
||||
export const availableLangs = {
|
||||
client: ['english', 'espanol', 'chinese', 'chinese-traditional', 'dothraki'],
|
||||
curriculum: [
|
||||
'english',
|
||||
'espanol',
|
||||
'chinese',
|
||||
'chinese-traditional',
|
||||
'dothraki'
|
||||
]
|
||||
};
|
||||
|
||||
export const auditedCerts = {
|
||||
espanol: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis
|
||||
],
|
||||
chinese: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis,
|
||||
SuperBlocks.QualityAssurance,
|
||||
SuperBlocks.SciCompPy,
|
||||
SuperBlocks.DataAnalysisPy,
|
||||
SuperBlocks.InfoSec,
|
||||
SuperBlocks.MachineLearningPy
|
||||
],
|
||||
'chinese-traditional': [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis,
|
||||
SuperBlocks.QualityAssurance,
|
||||
SuperBlocks.SciCompPy,
|
||||
SuperBlocks.DataAnalysisPy,
|
||||
SuperBlocks.InfoSec,
|
||||
SuperBlocks.MachineLearningPy
|
||||
],
|
||||
dothraki: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs
|
||||
]
|
||||
};
|
||||
|
||||
export const i18nextCodes = {
|
||||
english: 'en',
|
||||
espanol: 'es',
|
||||
chinese: 'zh',
|
||||
'chinese-traditional': 'zh-Hant',
|
||||
dothraki: 'mis'
|
||||
};
|
||||
|
||||
export enum LangNames = {
|
||||
english: 'English',
|
||||
espanol: 'Español',
|
||||
chinese: '中文（简体字）',
|
||||
'chinese-traditional': '中文（繁體字）',
|
||||
dothraki: 'Dothraki'
|
||||
};
|
||||
|
||||
export enum LangCodes = {
|
||||
english: 'en-US',
|
||||
espanol: 'es-419',
|
||||
chinese: 'zh',
|
||||
'chinese-traditional': 'zh-Hant',
|
||||
dothraki: 'mis'
|
||||
};
|
||||
|
||||
export const hiddenLangs = ['dothraki'];
|
||||
```
|
||||
|
||||
> [!NOTE] When a language has been set up in the deployment pipeline AND has a public `/news` instance live, it can be removed from the `hiddenLangs` array and be made available to the public.
|
||||
|
||||
Next, open the `client/src/utils/algolia-locale-setup.ts` file. This data is used for the search bar that loads `/news` articles. While it is unlikely that you are going to test this functionality, missing the data for your language can lead to errors when attempting to build the codebase locally.
|
||||
|
||||
Add an object for your language to the `algoliaIndices` object. You should use the the same values as the `english` object for local testing, replacing the `english` key with your language's `availableLangs` value.
|
||||
|
||||
> [!NOTE] If we have already deployed an instance of news in your target language, you can update the values to reflect the live instance. Otherwise, use the English values.
|
||||
|
||||
If you were to add Dothraki:
|
||||
|
||||
```js
|
||||
const algoliaIndices = {
|
||||
english: {
|
||||
name: 'news',
|
||||
searchPage: 'https://www.freecodecamp.org/news/search/'
|
||||
},
|
||||
espanol: {
|
||||
name: 'news-es',
|
||||
searchPage: 'https://www.freecodecamp.org/espanol/news/search/'
|
||||
},
|
||||
chinese: {
|
||||
name: 'news-zh',
|
||||
searchPage: 'https://chinese.freecodecamp.org/news/search/'
|
||||
},
|
||||
'chinese-traditional': {
|
||||
name: 'news-zh',
|
||||
searchPage: 'https://chinese.freecodecamp.org/news/search'
|
||||
},
|
||||
dothraki: {
|
||||
name: 'news',
|
||||
searchPage: 'https://www.freecodecamp.org/news/search/'
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
### Releasing a Superblock
|
||||
|
||||
After a superblock has been fully translated into a language, there are two steps to release it. First add the superblock enum to that language's `auditedCerts` array. So, if you want to release the new Responsive Web Design superblock for Dothraki, the array should look like this:
|
||||
|
||||
```ts
|
||||
export const auditedCerts = {
|
||||
// other languages
|
||||
dothraki: [
|
||||
SuperBlocks.RespWebDesignNew, // the newly translated superblock
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs
|
||||
]
|
||||
};
|
||||
```
|
||||
|
||||
Finally, if the superblock is in a "new" state (that is, replacing a legacy superblock), the `languagesWithAuditedBetaReleases` array should be updated to include the new language like this:
|
||||
|
||||
```ts
|
||||
export const languagesWithAuditedBetaReleases: ['english', 'dothraki'];
|
||||
```
|
||||
|
||||
This will move the new superblock to the correct place in the curriculum map on `/learn`.
|
||||
|
||||
## Enabling Localized Videos
|
||||
|
||||
For the video challenges, you need to change a few things. First add the new locale to the GraphQL query in the `client/src/templates/Challenges/video/Show.tsx` file. For example, adding Dothraki to the query:
|
||||
|
||||
```tsx
|
||||
query VideoChallenge($slug: String!) {
|
||||
challengeNode(fields: { slug: { eq: $slug } }) {
|
||||
videoId
|
||||
videoLocaleIds {
|
||||
espanol
|
||||
italian
|
||||
portuguese
|
||||
dothraki
|
||||
}
|
||||
...
|
||||
```
|
||||
|
||||
Then add an id for the new language to any video challenge in an audited block. For example, if `auditedCerts` in `all-langs.ts` includes `scientific-computing-with-python` for `dothraki`, then you must add a `dothraki` entry in `videoLocaleIds`. The frontmatter should then look like this:
|
||||
|
||||
```yml
|
||||
videoLocaleIds:
|
||||
espanol: 3muQV-Im3Z0
|
||||
italian: hiRTRAqNlpE
|
||||
portuguese: AelGAcoMXbI
|
||||
dothraki: new-id-here
|
||||
dashedName: introduction-why-program
|
||||
---
|
||||
```
|
||||
|
||||
Update the `VideoLocaleIds` interface in `client/src/redux/prop-types` to include the new language.
|
||||
|
||||
```ts
|
||||
export interface VideoLocaleIds {
|
||||
espanol?: string;
|
||||
italian?: string;
|
||||
portuguese?: string;
|
||||
dothraki?: string;
|
||||
}
|
||||
```
|
||||
|
||||
And finally update the challenge schema in `curriculum/schema/challengeSchema.js`.
|
||||
|
||||
```js
|
||||
videoLocaleIds: Joi.when('challengeType', {
|
||||
is: challengeTypes.video,
|
||||
then: Joi.object().keys({
|
||||
espanol: Joi.string(),
|
||||
italian: Joi.string(),
|
||||
portuguese: Joi.string(),
|
||||
dothraki: Joi.string()
|
||||
})
|
||||
}),
|
||||
```
|
||||
|
||||
## Client UI
|
||||
|
||||
You will need to take an additional step to handle the client UI translations.
|
||||
|
||||
The Crowdin workflows will automatically pull down _some_ of the UI translations, but there are a couple of files that need to be moved manually.
|
||||
|
||||
You will want to copy the following files from `/client/i18n/locales/english` to `/client/i18n/locales/<your-language>`, and apply translations as needed:
|
||||
|
||||
- `links.json`
|
||||
- `meta-tags.json`
|
||||
- `motivation.json`
|
||||
- `trending.json`
|
||||
|
||||
## Testing Translations Locally
|
||||
|
||||
If you would like to test translations locally, before adding them to our main repository - skip the Crowdin workflow changes. Follow the steps for enabling a language, then download the translations from Crowdin and load them into your local code.
|
||||
|
||||
Because the language has not been approved for production, our scripts are not automatically downloading the translations yet. Only staff have the access to directly download the translations - you are welcome to reach out to us in our [contributors chat room](https://discord.gg/PRyKn3Vbay), or you can translate the English markdown files locally for testing purposes.
|
||||
|
||||
Once you have the files, you will need to place them in the correct directory. For the curriculum challenges, you should place the certification folders (i.e. `01-responsive-web-design`) within the `curriculum/challenges/{lang}` directory. For our Dothraki translations, this would be `curriculum/challenges/dothraki`. The client translation `.json` files will go in the `client/i18n/locales/{lang}` directory.
|
||||
|
||||
Update your `.env` file to use your new language for `CLIENT_LOCALE` and `CURRICULUM_LOCALE`.
|
||||
|
||||
Once these are in place, you should be able to run `npm run develop` to view your translated version of freeCodeCamp.
|
||||
|
||||
> [!ATTENTION] While you may perform translations locally for the purpose of testing, we remind everyone that translations should _not_ be submitted through GitHub and should only be done through Crowdin. Be sure to reset your local codebase after you are done testing.
|
||||
@@ -65,7 +65,7 @@ This is an example of how part of the `trending.json` file has to look.
|
||||
}
|
||||
```
|
||||
|
||||
You will want to [build the translated client locally](how-to-test-translations-locally.md) to see if the titles have the right length. Each title must stay on a single line and not go to a new line.
|
||||
You will want to [build the translated client locally](how-to-enable-new-languages.md) to see if the titles have the right length. Each title must stay on a single line and not go to a new line.
|
||||
|
||||
### How to update the trending articles in the cdn
|
||||
|
||||
|
||||
@@ -19,11 +19,10 @@
|
||||
- [Work on documentation](how-to-work-on-the-docs-theme.md)
|
||||
- [Work on the component library](how-to-work-on-the-component-library.md)
|
||||
- **Guías adicionales**
|
||||
- [Previsualiza las traducciones localmente](how-to-test-translations-locally.md)
|
||||
- [Entiende la estructura de archivo del currículo](curriculum-file-structure.md)
|
||||
- [Depurar correos salientes localmente ](how-to-catch-outgoing-emails-locally.md)
|
||||
- [Configura freeCodeCamp en Windows (WSL)](how-to-setup-wsl.md)
|
||||
- [Flujo de trabajo de los tokens de usuario](user-token-workflow.md)
|
||||
- [Understand the curriculum file structure](curriculum-file-structure.md)
|
||||
- [Debug outgoing emails locally](how-to-catch-outgoing-emails-locally.md)
|
||||
- [Set up freeCodeCamp on Windows (WSL)](how-to-setup-wsl.md)
|
||||
- [User Token Workflow](user-token-workflow.md)
|
||||
|
||||
---
|
||||
|
||||
@@ -32,6 +31,7 @@
|
||||
- [Language Lead Handbook](language-lead-handbook.md)
|
||||
- [DevOps Handbook](devops.md)
|
||||
- [Courses VSCode Extension](courses-vscode-extension.md)
|
||||
- [Enable New Language](how-to-enable-new-languages.md)
|
||||
|
||||
---
|
||||
|
||||
|
||||
279
docs/i18n/espanol/how-to-enable-new-languages.md
Normal file
279
docs/i18n/espanol/how-to-enable-new-languages.md
Normal file
@@ -0,0 +1,279 @@
|
||||
# Deploying New Languages on `/learn`
|
||||
|
||||
Before you can release a new language, you will need to allow the languages to download from Crowdin.
|
||||
|
||||
## Updating Crowdin Settings
|
||||
|
||||
In the `Curriculum` and `Learn UI` projects, you will need to select `Project Settings` from the sidebar. Then scroll down to `Language Mapping`, where you will see an option to add custom language codes. Add a new entry for the language you are releasing, selecting `language` as the `Placeholder` value, and entering a URL-friendly lower-case spelling of your language's name for the `Custom code`. If you aren't sure what to use, reach out in our contributor chat and we will assist you.
|
||||
|
||||
## Updating Workflows
|
||||
|
||||
You will need to add a step to the `crowdin-download.client-ui.yml` and `crowdin-download.curriculum.yml`. The step for these will be the same. For example, if you want to enable Dothraki downloads:
|
||||
|
||||
```yml
|
||||
##### Download Dothraki #####
|
||||
- name: Crowdin Download Dothraki Translations
|
||||
uses: crowdin/github-action@master
|
||||
# options: https://github.com/crowdin/github-action/blob/master/action.yml
|
||||
with:
|
||||
# uploads
|
||||
upload_sources: false
|
||||
upload_translations: false
|
||||
auto_approve_imported: false
|
||||
import_eq_suggestions: false
|
||||
|
||||
# downloads
|
||||
download_translations: true
|
||||
download_language: mis
|
||||
skip_untranslated_files: false
|
||||
export_only_approved: true
|
||||
|
||||
push_translations: false
|
||||
|
||||
# pull-request
|
||||
create_pull_request: false
|
||||
|
||||
# global options
|
||||
config: './crowdin-config.yml'
|
||||
base_url: ${{ secrets.CROWDIN_BASE_URL_FCC }}
|
||||
|
||||
# Uncomment below to debug
|
||||
# dryrun_action: true
|
||||
```
|
||||
|
||||
Note that the `download_language` key needs to be set to the language code displayed on Crowdin.
|
||||
|
||||
## Enabling a Language
|
||||
|
||||
> [!NOTE] The above section with updating the workflows should be completed before proceeding - these need to be done in separate steps or the builds will fail.
|
||||
|
||||
There are a few steps to take in order to allow the codebase to build in your desired language.
|
||||
|
||||
First, visit the `config/i18n/all-langs.ts` file to add the language to the available languages list and configure the values. There are several objects here.
|
||||
|
||||
- `availableLangs`: For both the `client` and `curriculum` arrays, add the text name of the language. This is the value that will be used in the `.env` file later.
|
||||
- `auditedCerts`: Add the text name of the language as the _key_, and add an array of `SuperBlocks.{cert}` variables as the _value_. This tells the client which certifications are fully translated.
|
||||
- `i18nextCodes`: These are the ISO language codes for each language. You will need to add the appropriate ISO code for the language you are enabling. These do need to be unique for each language.
|
||||
- `LangNames`: These are the display names for the language selector in the navigation menu.
|
||||
- `LangCodes`: These are the language codes used for formatting dates and numbers. These should be Unicode CLDR codes instead of ISO codes.
|
||||
- `hiddenLangs`: These languages will not be displayed in the navigation menu. This is used for languages that are not yet ready for release.
|
||||
|
||||
As an example, if you wanted to enable Dothraki as a language, your `all-langs.js` objects should look like this:
|
||||
|
||||
```js
|
||||
export const availableLangs = {
|
||||
client: ['english', 'espanol', 'chinese', 'chinese-traditional', 'dothraki'],
|
||||
curriculum: [
|
||||
'english',
|
||||
'espanol',
|
||||
'chinese',
|
||||
'chinese-traditional',
|
||||
'dothraki'
|
||||
]
|
||||
};
|
||||
|
||||
export const auditedCerts = {
|
||||
espanol: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis
|
||||
],
|
||||
chinese: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis,
|
||||
SuperBlocks.QualityAssurance,
|
||||
SuperBlocks.SciCompPy,
|
||||
SuperBlocks.DataAnalysisPy,
|
||||
SuperBlocks.InfoSec,
|
||||
SuperBlocks.MachineLearningPy
|
||||
],
|
||||
'chinese-traditional': [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis,
|
||||
SuperBlocks.QualityAssurance,
|
||||
SuperBlocks.SciCompPy,
|
||||
SuperBlocks.DataAnalysisPy,
|
||||
SuperBlocks.InfoSec,
|
||||
SuperBlocks.MachineLearningPy
|
||||
],
|
||||
dothraki: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs
|
||||
]
|
||||
};
|
||||
|
||||
export const i18nextCodes = {
|
||||
english: 'en',
|
||||
espanol: 'es',
|
||||
chinese: 'zh',
|
||||
'chinese-traditional': 'zh-Hant',
|
||||
dothraki: 'mis'
|
||||
};
|
||||
|
||||
export enum LangNames = {
|
||||
english: 'English',
|
||||
espanol: 'Español',
|
||||
chinese: '中文（简体字）',
|
||||
'chinese-traditional': '中文（繁體字）',
|
||||
dothraki: 'Dothraki'
|
||||
};
|
||||
|
||||
export enum LangCodes = {
|
||||
english: 'en-US',
|
||||
espanol: 'es-419',
|
||||
chinese: 'zh',
|
||||
'chinese-traditional': 'zh-Hant',
|
||||
dothraki: 'mis'
|
||||
};
|
||||
|
||||
export const hiddenLangs = ['dothraki'];
|
||||
```
|
||||
|
||||
> [!NOTE] When a language has been set up in the deployment pipeline AND has a public `/news` instance live, it can be removed from the `hiddenLangs` array and be made available to the public.
|
||||
|
||||
Next, open the `client/src/utils/algolia-locale-setup.ts` file. This data is used for the search bar that loads `/news` articles. While it is unlikely that you are going to test this functionality, missing the data for your language can lead to errors when attempting to build the codebase locally.
|
||||
|
||||
Add an object for your language to the `algoliaIndices` object. You should use the the same values as the `english` object for local testing, replacing the `english` key with your language's `availableLangs` value.
|
||||
|
||||
> [!NOTE] If we have already deployed an instance of news in your target language, you can update the values to reflect the live instance. Otherwise, use the English values.
|
||||
|
||||
If you were to add Dothraki:
|
||||
|
||||
```js
|
||||
const algoliaIndices = {
|
||||
english: {
|
||||
name: 'news',
|
||||
searchPage: 'https://www.freecodecamp.org/news/search/'
|
||||
},
|
||||
espanol: {
|
||||
name: 'news-es',
|
||||
searchPage: 'https://www.freecodecamp.org/espanol/news/search/'
|
||||
},
|
||||
chinese: {
|
||||
name: 'news-zh',
|
||||
searchPage: 'https://chinese.freecodecamp.org/news/search/'
|
||||
},
|
||||
'chinese-traditional': {
|
||||
name: 'news-zh',
|
||||
searchPage: 'https://chinese.freecodecamp.org/news/search'
|
||||
},
|
||||
dothraki: {
|
||||
name: 'news',
|
||||
searchPage: 'https://www.freecodecamp.org/news/search/'
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
### Releasing a Superblock
|
||||
|
||||
After a superblock has been fully translated into a language, there are two steps to release it. First add the superblock enum to that language's `auditedCerts` array. So, if you want to release the new Responsive Web Design superblock for Dothraki, the array should look like this:
|
||||
|
||||
```ts
|
||||
export const auditedCerts = {
|
||||
// other languages
|
||||
dothraki: [
|
||||
SuperBlocks.RespWebDesignNew, // the newly translated superblock
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs
|
||||
]
|
||||
};
|
||||
```
|
||||
|
||||
Finally, if the superblock is in a "new" state (that is, replacing a legacy superblock), the `languagesWithAuditedBetaReleases` array should be updated to include the new language like this:
|
||||
|
||||
```ts
|
||||
export const languagesWithAuditedBetaReleases: ['english', 'dothraki'];
|
||||
```
|
||||
|
||||
This will move the new superblock to the correct place in the curriculum map on `/learn`.
|
||||
|
||||
## Enabling Localized Videos
|
||||
|
||||
For the video challenges, you need to change a few things. First add the new locale to the GraphQL query in the `client/src/templates/Challenges/video/Show.tsx` file. For example, adding Dothraki to the query:
|
||||
|
||||
```tsx
|
||||
query VideoChallenge($slug: String!) {
|
||||
challengeNode(fields: { slug: { eq: $slug } }) {
|
||||
videoId
|
||||
videoLocaleIds {
|
||||
espanol
|
||||
italian
|
||||
portuguese
|
||||
dothraki
|
||||
}
|
||||
...
|
||||
```
|
||||
|
||||
Then add an id for the new language to any video challenge in an audited block. For example, if `auditedCerts` in `all-langs.ts` includes `scientific-computing-with-python` for `dothraki`, then you must add a `dothraki` entry in `videoLocaleIds`. The frontmatter should then look like this:
|
||||
|
||||
```yml
|
||||
videoLocaleIds:
|
||||
espanol: 3muQV-Im3Z0
|
||||
italian: hiRTRAqNlpE
|
||||
portuguese: AelGAcoMXbI
|
||||
dothraki: new-id-here
|
||||
dashedName: introduction-why-program
|
||||
---
|
||||
```
|
||||
|
||||
Update the `VideoLocaleIds` interface in `client/src/redux/prop-types` to include the new language.
|
||||
|
||||
```ts
|
||||
export interface VideoLocaleIds {
|
||||
espanol?: string;
|
||||
italian?: string;
|
||||
portuguese?: string;
|
||||
dothraki?: string;
|
||||
}
|
||||
```
|
||||
|
||||
And finally update the challenge schema in `curriculum/schema/challengeSchema.js`.
|
||||
|
||||
```js
|
||||
videoLocaleIds: Joi.when('challengeType', {
|
||||
is: challengeTypes.video,
|
||||
then: Joi.object().keys({
|
||||
espanol: Joi.string(),
|
||||
italian: Joi.string(),
|
||||
portuguese: Joi.string(),
|
||||
dothraki: Joi.string()
|
||||
})
|
||||
}),
|
||||
```
|
||||
|
||||
## Client UI
|
||||
|
||||
You will need to take an additional step to handle the client UI translations.
|
||||
|
||||
The Crowdin workflows will automatically pull down _some_ of the UI translations, but there are a couple of files that need to be moved manually.
|
||||
|
||||
You will want to copy the following files from `/client/i18n/locales/english` to `/client/i18n/locales/<your-language>`, and apply translations as needed:
|
||||
|
||||
- `links.json`
|
||||
- `meta-tags.json`
|
||||
- `motivation.json`
|
||||
- `trending.json`
|
||||
|
||||
## Testing Translations Locally
|
||||
|
||||
If you would like to test translations locally, before adding them to our main repository - skip the Crowdin workflow changes. Follow the steps for enabling a language, then download the translations from Crowdin and load them into your local code.
|
||||
|
||||
Because the language has not been approved for production, our scripts are not automatically downloading the translations yet. Only staff have the access to directly download the translations - you are welcome to reach out to us in our [contributors chat room](https://discord.gg/PRyKn3Vbay), or you can translate the English markdown files locally for testing purposes.
|
||||
|
||||
Once you have the files, you will need to place them in the correct directory. For the curriculum challenges, you should place the certification folders (i.e. `01-responsive-web-design`) within the `curriculum/challenges/{lang}` directory. For our Dothraki translations, this would be `curriculum/challenges/dothraki`. The client translation `.json` files will go in the `client/i18n/locales/{lang}` directory.
|
||||
|
||||
Update your `.env` file to use your new language for `CLIENT_LOCALE` and `CURRICULUM_LOCALE`.
|
||||
|
||||
Once these are in place, you should be able to run `npm run develop` to view your translated version of freeCodeCamp.
|
||||
|
||||
> [!ATTENTION] While you may perform translations locally for the purpose of testing, we remind everyone that translations should _not_ be submitted through GitHub and should only be done through Crowdin. Be sure to reset your local codebase after you are done testing.
|
||||
@@ -65,7 +65,7 @@ This is an example of how part of the `trending.json` file has to look.
|
||||
}
|
||||
```
|
||||
|
||||
You will want to [build the translated client locally](how-to-test-translations-locally.md) to see if the titles have the right length. Each title must stay on a single line and not go to a new line.
|
||||
You will want to [build the translated client locally](how-to-enable-new-languages.md) to see if the titles have the right length. Each title must stay on a single line and not go to a new line.
|
||||
|
||||
### How to update the trending articles in the cdn
|
||||
|
||||
|
||||
@@ -19,10 +19,9 @@
|
||||
- [Arbeite an der Dokumentation](how-to-work-on-the-docs-theme.md)
|
||||
- [Arbeite an der Komponentenbibliothek](how-to-work-on-the-component-library.md)
|
||||
- **Zusätzliche Leitfäden**
|
||||
- [Übersetzungen lokal testen](how-to-test-translations-locally.md)
|
||||
- [Verstehe die Dateistruktur des Studienplans](curriculum-file-structure.md)
|
||||
- [Ausgehende Emails lokal debuggen](how-to-catch-outgoing-emails-locally.md)
|
||||
- [freeCodeCamp auf Windows einrichten (WSL)](how-to-setup-wsl.md)
|
||||
- [Curriculum-Dateistruktur verstehen](curriculum-file-structure.md)
|
||||
- [Ausgehende E-Mails lokal debuggen](how-to-catch-outgoing-emails-locally.md)
|
||||
- [freeCodeCamp unter Windows einrichten (WSL)](how-to-setup-wsl.md)
|
||||
- [Benutzer-Token Workflow](user-token-workflow.md)
|
||||
|
||||
---
|
||||
@@ -32,10 +31,11 @@
|
||||
- [Language Lead Handbuch](language-lead-handbook.md)
|
||||
- [DevOps-Handbuch](devops.md)
|
||||
- [Kurse VSCode Erweiterung](courses-vscode-extension.md)
|
||||
- [Eine neue Sprache aktivieren](how-to-enable-new-languages.md)
|
||||
|
||||
---
|
||||
|
||||
- **Unsere Community**
|
||||
- [**GitHub**](https://github.com/freecodecamp/freecodecamp)
|
||||
- [**Discourse Forum**](https://freecodecamp.org/forum/c/contributors)
|
||||
- [**Diskussionsforum**](https://freecodecamp.org/forum/c/contributors)
|
||||
- [**Chatserver**](https://discord.gg/PRyKn3Vbay)
|
||||
|
||||
279
docs/i18n/german/how-to-enable-new-languages.md
Normal file
279
docs/i18n/german/how-to-enable-new-languages.md
Normal file
@@ -0,0 +1,279 @@
|
||||
# Deploying New Languages on `/learn`
|
||||
|
||||
Before you can release a new language, you will need to allow the languages to download from Crowdin.
|
||||
|
||||
## Updating Crowdin Settings
|
||||
|
||||
In the `Curriculum` and `Learn UI` projects, you will need to select `Project Settings` from the sidebar. Then scroll down to `Language Mapping`, where you will see an option to add custom language codes. Add a new entry for the language you are releasing, selecting `language` as the `Placeholder` value, and entering a URL-friendly lower-case spelling of your language's name for the `Custom code`. If you aren't sure what to use, reach out in our contributor chat and we will assist you.
|
||||
|
||||
## Updating Workflows
|
||||
|
||||
You will need to add a step to the `crowdin-download.client-ui.yml` and `crowdin-download.curriculum.yml`. The step for these will be the same. For example, if you want to enable Dothraki downloads:
|
||||
|
||||
```yml
|
||||
##### Download Dothraki #####
|
||||
- name: Crowdin Download Dothraki Translations
|
||||
uses: crowdin/github-action@master
|
||||
# options: https://github.com/crowdin/github-action/blob/master/action.yml
|
||||
with:
|
||||
# uploads
|
||||
upload_sources: false
|
||||
upload_translations: false
|
||||
auto_approve_imported: false
|
||||
import_eq_suggestions: false
|
||||
|
||||
# downloads
|
||||
download_translations: true
|
||||
download_language: mis
|
||||
skip_untranslated_files: false
|
||||
export_only_approved: true
|
||||
|
||||
push_translations: false
|
||||
|
||||
# pull-request
|
||||
create_pull_request: false
|
||||
|
||||
# global options
|
||||
config: './crowdin-config.yml'
|
||||
base_url: ${{ secrets.CROWDIN_BASE_URL_FCC }}
|
||||
|
||||
# Uncomment below to debug
|
||||
# dryrun_action: true
|
||||
```
|
||||
|
||||
Note that the `download_language` key needs to be set to the language code displayed on Crowdin.
|
||||
|
||||
## Enabling a Language
|
||||
|
||||
> [!NOTE] The above section with updating the workflows should be completed before proceeding - these need to be done in separate steps or the builds will fail.
|
||||
|
||||
There are a few steps to take in order to allow the codebase to build in your desired language.
|
||||
|
||||
First, visit the `config/i18n/all-langs.ts` file to add the language to the available languages list and configure the values. There are several objects here.
|
||||
|
||||
- `availableLangs`: For both the `client` and `curriculum` arrays, add the text name of the language. This is the value that will be used in the `.env` file later.
|
||||
- `auditedCerts`: Add the text name of the language as the _key_, and add an array of `SuperBlocks.{cert}` variables as the _value_. This tells the client which certifications are fully translated.
|
||||
- `i18nextCodes`: These are the ISO language codes for each language. You will need to add the appropriate ISO code for the language you are enabling. These do need to be unique for each language.
|
||||
- `LangNames`: These are the display names for the language selector in the navigation menu.
|
||||
- `LangCodes`: These are the language codes used for formatting dates and numbers. These should be Unicode CLDR codes instead of ISO codes.
|
||||
- `hiddenLangs`: These languages will not be displayed in the navigation menu. This is used for languages that are not yet ready for release.
|
||||
|
||||
As an example, if you wanted to enable Dothraki as a language, your `all-langs.js` objects should look like this:
|
||||
|
||||
```js
|
||||
export const availableLangs = {
|
||||
client: ['english', 'espanol', 'chinese', 'chinese-traditional', 'dothraki'],
|
||||
curriculum: [
|
||||
'english',
|
||||
'espanol',
|
||||
'chinese',
|
||||
'chinese-traditional',
|
||||
'dothraki'
|
||||
]
|
||||
};
|
||||
|
||||
export const auditedCerts = {
|
||||
espanol: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis
|
||||
],
|
||||
chinese: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis,
|
||||
SuperBlocks.QualityAssurance,
|
||||
SuperBlocks.SciCompPy,
|
||||
SuperBlocks.DataAnalysisPy,
|
||||
SuperBlocks.InfoSec,
|
||||
SuperBlocks.MachineLearningPy
|
||||
],
|
||||
'chinese-traditional': [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis,
|
||||
SuperBlocks.QualityAssurance,
|
||||
SuperBlocks.SciCompPy,
|
||||
SuperBlocks.DataAnalysisPy,
|
||||
SuperBlocks.InfoSec,
|
||||
SuperBlocks.MachineLearningPy
|
||||
],
|
||||
dothraki: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs
|
||||
]
|
||||
};
|
||||
|
||||
export const i18nextCodes = {
|
||||
english: 'en',
|
||||
espanol: 'es',
|
||||
chinese: 'zh',
|
||||
'chinese-traditional': 'zh-Hant',
|
||||
dothraki: 'mis'
|
||||
};
|
||||
|
||||
export enum LangNames = {
|
||||
english: 'English',
|
||||
espanol: 'Español',
|
||||
chinese: '中文（简体字）',
|
||||
'chinese-traditional': '中文（繁體字）',
|
||||
dothraki: 'Dothraki'
|
||||
};
|
||||
|
||||
export enum LangCodes = {
|
||||
english: 'en-US',
|
||||
espanol: 'es-419',
|
||||
chinese: 'zh',
|
||||
'chinese-traditional': 'zh-Hant',
|
||||
dothraki: 'mis'
|
||||
};
|
||||
|
||||
export const hiddenLangs = ['dothraki'];
|
||||
```
|
||||
|
||||
> [!NOTE] When a language has been set up in the deployment pipeline AND has a public `/news` instance live, it can be removed from the `hiddenLangs` array and be made available to the public.
|
||||
|
||||
Next, open the `client/src/utils/algolia-locale-setup.ts` file. This data is used for the search bar that loads `/news` articles. While it is unlikely that you are going to test this functionality, missing the data for your language can lead to errors when attempting to build the codebase locally.
|
||||
|
||||
Add an object for your language to the `algoliaIndices` object. You should use the the same values as the `english` object for local testing, replacing the `english` key with your language's `availableLangs` value.
|
||||
|
||||
> [!NOTE] If we have already deployed an instance of news in your target language, you can update the values to reflect the live instance. Otherwise, use the English values.
|
||||
|
||||
If you were to add Dothraki:
|
||||
|
||||
```js
|
||||
const algoliaIndices = {
|
||||
english: {
|
||||
name: 'news',
|
||||
searchPage: 'https://www.freecodecamp.org/news/search/'
|
||||
},
|
||||
espanol: {
|
||||
name: 'news-es',
|
||||
searchPage: 'https://www.freecodecamp.org/espanol/news/search/'
|
||||
},
|
||||
chinese: {
|
||||
name: 'news-zh',
|
||||
searchPage: 'https://chinese.freecodecamp.org/news/search/'
|
||||
},
|
||||
'chinese-traditional': {
|
||||
name: 'news-zh',
|
||||
searchPage: 'https://chinese.freecodecamp.org/news/search'
|
||||
},
|
||||
dothraki: {
|
||||
name: 'news',
|
||||
searchPage: 'https://www.freecodecamp.org/news/search/'
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
### Releasing a Superblock
|
||||
|
||||
After a superblock has been fully translated into a language, there are two steps to release it. First add the superblock enum to that language's `auditedCerts` array. So, if you want to release the new Responsive Web Design superblock for Dothraki, the array should look like this:
|
||||
|
||||
```ts
|
||||
export const auditedCerts = {
|
||||
// other languages
|
||||
dothraki: [
|
||||
SuperBlocks.RespWebDesignNew, // the newly translated superblock
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs
|
||||
]
|
||||
};
|
||||
```
|
||||
|
||||
Finally, if the superblock is in a "new" state (that is, replacing a legacy superblock), the `languagesWithAuditedBetaReleases` array should be updated to include the new language like this:
|
||||
|
||||
```ts
|
||||
export const languagesWithAuditedBetaReleases: ['english', 'dothraki'];
|
||||
```
|
||||
|
||||
This will move the new superblock to the correct place in the curriculum map on `/learn`.
|
||||
|
||||
## Enabling Localized Videos
|
||||
|
||||
For the video challenges, you need to change a few things. First add the new locale to the GraphQL query in the `client/src/templates/Challenges/video/Show.tsx` file. For example, adding Dothraki to the query:
|
||||
|
||||
```tsx
|
||||
query VideoChallenge($slug: String!) {
|
||||
challengeNode(fields: { slug: { eq: $slug } }) {
|
||||
videoId
|
||||
videoLocaleIds {
|
||||
espanol
|
||||
italian
|
||||
portuguese
|
||||
dothraki
|
||||
}
|
||||
...
|
||||
```
|
||||
|
||||
Then add an id for the new language to any video challenge in an audited block. For example, if `auditedCerts` in `all-langs.ts` includes `scientific-computing-with-python` for `dothraki`, then you must add a `dothraki` entry in `videoLocaleIds`. The frontmatter should then look like this:
|
||||
|
||||
```yml
|
||||
videoLocaleIds:
|
||||
espanol: 3muQV-Im3Z0
|
||||
italian: hiRTRAqNlpE
|
||||
portuguese: AelGAcoMXbI
|
||||
dothraki: new-id-here
|
||||
dashedName: introduction-why-program
|
||||
---
|
||||
```
|
||||
|
||||
Update the `VideoLocaleIds` interface in `client/src/redux/prop-types` to include the new language.
|
||||
|
||||
```ts
|
||||
export interface VideoLocaleIds {
|
||||
espanol?: string;
|
||||
italian?: string;
|
||||
portuguese?: string;
|
||||
dothraki?: string;
|
||||
}
|
||||
```
|
||||
|
||||
And finally update the challenge schema in `curriculum/schema/challengeSchema.js`.
|
||||
|
||||
```js
|
||||
videoLocaleIds: Joi.when('challengeType', {
|
||||
is: challengeTypes.video,
|
||||
then: Joi.object().keys({
|
||||
espanol: Joi.string(),
|
||||
italian: Joi.string(),
|
||||
portuguese: Joi.string(),
|
||||
dothraki: Joi.string()
|
||||
})
|
||||
}),
|
||||
```
|
||||
|
||||
## Client UI
|
||||
|
||||
You will need to take an additional step to handle the client UI translations.
|
||||
|
||||
The Crowdin workflows will automatically pull down _some_ of the UI translations, but there are a couple of files that need to be moved manually.
|
||||
|
||||
You will want to copy the following files from `/client/i18n/locales/english` to `/client/i18n/locales/<your-language>`, and apply translations as needed:
|
||||
|
||||
- `links.json`
|
||||
- `meta-tags.json`
|
||||
- `motivation.json`
|
||||
- `trending.json`
|
||||
|
||||
## Testing Translations Locally
|
||||
|
||||
If you would like to test translations locally, before adding them to our main repository - skip the Crowdin workflow changes. Follow the steps for enabling a language, then download the translations from Crowdin and load them into your local code.
|
||||
|
||||
Because the language has not been approved for production, our scripts are not automatically downloading the translations yet. Only staff have the access to directly download the translations - you are welcome to reach out to us in our [contributors chat room](https://discord.gg/PRyKn3Vbay), or you can translate the English markdown files locally for testing purposes.
|
||||
|
||||
Once you have the files, you will need to place them in the correct directory. For the curriculum challenges, you should place the certification folders (i.e. `01-responsive-web-design`) within the `curriculum/challenges/{lang}` directory. For our Dothraki translations, this would be `curriculum/challenges/dothraki`. The client translation `.json` files will go in the `client/i18n/locales/{lang}` directory.
|
||||
|
||||
Update your `.env` file to use your new language for `CLIENT_LOCALE` and `CURRICULUM_LOCALE`.
|
||||
|
||||
Once these are in place, you should be able to run `npm run develop` to view your translated version of freeCodeCamp.
|
||||
|
||||
> [!ATTENTION] While you may perform translations locally for the purpose of testing, we remind everyone that translations should _not_ be submitted through GitHub and should only be done through Crowdin. Be sure to reset your local codebase after you are done testing.
|
||||
@@ -22,31 +22,31 @@ Du kannst helfen, den Studienplan zu erweitern und zu verbessern. Du kannst auch
|
||||
|
||||
Wir lokalisieren freeCodeCamp.org in die wichtigsten Sprachen der Welt.
|
||||
|
||||
Certifications are already live in some major world languages like below:
|
||||
Die Zertifizierungen sind bereits in einigen wichtigen Weltsprachen, wie unten zu sehen, verfügbar:
|
||||
|
||||
- [Chinese (中文)](https://chinese.freecodecamp.org/learn)
|
||||
- [Spanish (Español)](https://www.freecodecamp.org/espanol/learn)
|
||||
- [Italian (Italiano)](https://www.freecodecamp.org/italian/learn)
|
||||
- [Portuguese (Português)](https://www.freecodecamp.org/portuguese/learn)
|
||||
- [Ukrainian (Українська)](https://www.freecodecamp.org/ukrainian/learn)
|
||||
- [Japanese (日本語)](https://www.freecodecamp.org/japanese/learn)
|
||||
- [Chinesisch (中文)](https://chinese.freecodecamp.org/learn)
|
||||
- [Spanisch (Español)](https://www.freecodecamp.org/espanol/learn)
|
||||
- [Italienisch (Italiano)](https://www.freecodecamp.org/italian/learn)
|
||||
- [Portugiesisch (Português)](https://www.freecodecamp.org/portuguese/learn)
|
||||
- [Ukrainisch (Українська)](https://www.freecodecamp.org/ukrainian/learn)
|
||||
- [Japanisch (日本語)](https://www.freecodecamp.org/japanese/learn)
|
||||
|
||||
We encourage you to read the [announcement here](https://www.freecodecamp.org/news/help-translate-freecodecamp-language/) and share it with your friends to get them excited about this.
|
||||
Wir möchten dich dazu ermutigen, die [Ankündigung hier](https://www.freecodecamp.org/news/help-translate-freecodecamp-language/) zu lesen und sie an deine Freunde weiterzuleiten, um sie für dieses Thema zu begeistern.
|
||||
|
||||
**If you're interested in translating, here's [how to translate freeCodeCamp's resources](how-to-translate-files.md).**
|
||||
**Wenn du daran interessiert bist, zu übersetzen, findest du hier [eine Anleitung zum Übersetzen der freeCodeCamp-Ressourcen](how-to-translate-files.md).**
|
||||
|
||||
## Lernplattform
|
||||
|
||||
Our learning platform runs on a modern JavaScript stack. It has various components, tools, and libraries. These include Node.js, MongoDB, OAuth 2.0, React, Gatsby, Webpack, and more.
|
||||
Unsere Lernplattform läuft auf einem modernen JavaScript-Stack. Es umfasst verschiedene Komponenten, Werkzeuge und Bibliotheken. Dazu gehören Node.js, MongoDB, OAuth 2.0, React, Gatsby, Webpack und mehr.
|
||||
|
||||
Broadly, we have a Node.js based API server, a set of React-based client applications, testing scripts to evaluate camper-submitted curriculum projects, and more. If you want to productively contribute to the learning platform, we recommend some familiarity with these tools.
|
||||
Im Großen und Ganzen haben wir einen Node.js-basierten API-Server, eine Reihe von React-basierten Client-Anwendungen, Testskripte, um die von Teilnehmer:innen eingereichten Studienplanprojekten zu bewerten, und einiges mehr. Wenn du einen produktiven Beitrag zur Lernplattform leisten willst, empfehlen wir dir, dich mit diesen Werkzeugen etwas vertraut zu machen.
|
||||
|
||||
If you want to help us improve our codebase...
|
||||
Wenn du uns helfen willst, unsere Codebasis zu verbessern...
|
||||
|
||||
**you can either use Gitpod, a free online dev environment that starts a ready-to-code dev environment for freeCodeCamp in your browser.**
|
||||
**kannst du entweder Gitpod verwenden, eine kostenlose Online-Entwicklungsumgebung, die eine programmierfertige Entwicklungsumgebung für freeCodeCamp in Ihrem Browser startet.**
|
||||
|
||||
[](https://gitpod.io/#https://github.com/freeCodeCamp/freeCodeCamp)
|
||||
[](https://gitpod.io/#https://github.com/freeCodeCamp/freeCodeCamp)
|
||||
|
||||
Or you can...
|
||||
Oder du kannst...
|
||||
|
||||
**[Set up freeCodeCamp locally](how-to-setup-freecodecamp-locally.md) on your machine.**
|
||||
**[freeCodeCamp lokal](how-to-setup-freecodecamp-locally.md) auf deinem Rechner einrichten.**
|
||||
|
||||
@@ -1,22 +1,22 @@
|
||||
# The Official freeCodeCamp Language Lead Handbook
|
||||
# Das offizielle freeCodeCamp-Language Lead-Handbuch
|
||||
|
||||
This handbook will help you set up and use the tools for your localization efforts.
|
||||
Dieses Handbuch hilft dir dabei, die Tools für deine Lokalisierungsvorhaben einzurichten und zu nutzen.
|
||||
|
||||
## How to invite new contributors to Ghost
|
||||
## Wie du neue Mitwirkende zu Ghost einlädst
|
||||
|
||||
Ghost allows you to set contributors with different levels of authorizations.
|
||||
Ghost ermöglicht es dir, Mitwirkende mit verschiedenen Berechtigungsstufen festzulegen.
|
||||
|
||||
Most of your invites will be for the "Contributor" level. This level allows the user to create drafts. Select this role when inviting a new translator.
|
||||
Die meisten Ihrer Einladungen werden für die Stufe "Contributor " sein. Auf dieser Ebene kann der Benutzer Entwürfe erstellen. Wähle diese Rolle, wenn du einen neuen Übersetzer einlädst.
|
||||
|
||||
The "Author" level allows the user to create Drafts and publish them.
|
||||
Die Stufe "Author" ermöglicht es dem Benutzer, Entwürfe zu erstellen und diese zu veröffentlichen.
|
||||
|
||||
The "Editor" level allows the user to access all Drafts and publish them. Select this role when inviting a new proofreader.
|
||||
Auf der Ebene "Editor" hat der Benutzer Zugriff auf alle Entwürfe und kann sie veröffentlichen. Wähle diese Rolle, wenn du einen neuen Korrekturleser (proofreader) einlädst.
|
||||
|
||||
The "Administrator" level is reserved for freeCodeCamp staff and Language Leads.
|
||||
Die Stufe "Administrator" ist für freeCodeCamp-Mitarbeiter und Language Leads reserviert.
|
||||
|
||||
## How to mention the original author of a translated article
|
||||
## Wie man den Originalautor eines übersetzten Artikels erwähnt
|
||||
|
||||
The original author and the original article are linked automatically adding this code to the Code Injection -> head section in the Draft Settings on ghost.
|
||||
Der ursprüngliche Autor und der ursprüngliche Artikel werden automatisch verlinkt, indem dieser Code dem Abschnitt Code Injection -> head in den Entwurfs-Einstellungen auf Ghost hinzugefügt wird.
|
||||
|
||||
```html
|
||||
<script>
|
||||
@@ -24,28 +24,28 @@ The original author and the original article are linked automatically adding thi
|
||||
</script>
|
||||
```
|
||||
|
||||
With `link` being the link of the original article.
|
||||
`Link` ist der Link zum Originalartikel.
|
||||
|
||||
## How to update trending articles
|
||||
## Wie man angesagte Artikel aktualisiert
|
||||
|
||||
> [!TIP] Changing the articles in the footer at least once a month means giving a boost to the linked articles on google results.
|
||||
> [!TIP] Die Artikel in der Fußzeile mindestens einmal im Monat zu ändern, führt zu einer Verbesserung der Google-Ergebnisse für die verlinkten Artikel.
|
||||
|
||||
There are two places in which to change the trending articles.
|
||||
Es gibt zwei Stellen, an denen du die angesagten Artikel ändern kannst.
|
||||
|
||||
- [The curriculum repository](https://github.com/freeCodeCamp/freeCodeCamp/)
|
||||
- [The CDN repository](https://github.com/freeCodeCamp/cdn)
|
||||
- [Das Curriculum-Repository](https://github.com/freeCodeCamp/freeCodeCamp/)
|
||||
- [Das CDN-Repository](https://github.com/freeCodeCamp/cdn)
|
||||
|
||||
For each article you will need to create a shorter title to use in the footer.
|
||||
Für jeden Artikel musst du einen kürzeren Titel erstellen, den du in der Fußzeile (Footer) verwenden kannst.
|
||||
|
||||
### Change trending articles in the curriculum
|
||||
### Änderung angesagter Artikel im Lehrplan (Curriculum)
|
||||
|
||||
The trending articles in the curriculum footer can be changed by editing the file at `client/i18n/locales/<language>/trending.json`.
|
||||
Die angesagte Artikel in der Fußzeile des Lehrplans können durch Bearbeiten der Datei `client/i18n/locales/<language>/trending.json` geändert werden.
|
||||
|
||||
This file is a `*.json` file that has the shape of an object with property keys in the shape `article0title` and `article0link`.
|
||||
Diese Datei ist eine `*.json`-Datei, die die Form eines Objekts mit Eigenschaftsschlüsseln in der Form `article0title` und `article0link` hat.
|
||||
|
||||
Each number rapresents one of the 30 articles in the footer. Make sure to match the title and the link correctly.
|
||||
Jede Zahl steht für einen der 30 Artikel in der Fußzeile. Achte darauf, dass der Titel und der Link richtig zugeordnet sind.
|
||||
|
||||
This is an example of how part of the `trending.json` file has to look.
|
||||
Dies ist ein Beispiel dafür, wie ein Teil der Datei `trending.json` aussehen muss.
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -65,13 +65,13 @@ This is an example of how part of the `trending.json` file has to look.
|
||||
}
|
||||
```
|
||||
|
||||
You will want to [build the translated client locally](how-to-test-translations-locally.md) to see if the titles have the right length. Each title must stay on a single line and not go to a new line.
|
||||
Du solltest [den übersetzten Client lokal einrichten](how-to-enable-new-languages.md), um zu sehen, ob die Titel die richtige Länge haben. Jeder Titel muss in einer einzigen Zeile bleiben und darf nicht in eine neue Zeile übergehen.
|
||||
|
||||
### How to update the trending articles in the cdn
|
||||
### Wie man angesagte Artikel im cdn aktualisiert
|
||||
|
||||
The file in the cdn repository is the file `universal/trending/<language>.yaml`.
|
||||
Die Datei im cdn-Repository ist die Datei `universal/trending/<language>.yaml`.
|
||||
|
||||
This file is shaped differently, for example here the file content for the first 6 articles:
|
||||
Diese Datei ist unterschiedlich aufgebaut, zum Beispiel hier der Inhalt der ersten 6 Artikel:
|
||||
|
||||
```yaml
|
||||
article0title: 'Unire CSV con Python'
|
||||
@@ -88,27 +88,27 @@ article5title: 'Cosa è API?'
|
||||
article5link: 'https://www.freecodecamp.org/italian/news/cose-un-api-in-italiano-per-favore/'
|
||||
```
|
||||
|
||||
You can convert from one format to the other carefully changing it manually. Or you can use [the script in this repl](https://replit.com/@Ieahleen/convert-json-to-yaml).
|
||||
Du kannst von einem Format in ein anderes konvertieren, indem du es vorsichtig manuell ändern. Oder du kannst [das Skript in diesem Repl](https://replit.com/@Ieahleen/convert-json-to-yaml) verwenden.
|
||||
|
||||
> [!TIP] A new workflow is being worked on, there will be only one place to change in the future.
|
||||
> [!TIP] Es wird an einem neuen Arbeitsablauf gearbeitet, sodass es in Zukunft nur noch eine Stelle gibt, an der Änderungen vorgenommen werden müssen.
|
||||
|
||||
## How to translate the info boxes headers in the documentation
|
||||
## Wie man die Überschriften der Infoboxen in der Dokumentation übersetzt
|
||||
|
||||
You can find these boxes all around the documentation:
|
||||
Du findest diese Boxen überall in der Dokumentation:
|
||||
|
||||
> [!NOTE] I am a note box
|
||||
> [!NOTE] Ich bin eine Notizbox
|
||||
|
||||
> [!TIP] I am a tip box
|
||||
> [!TIP] Ich bin eine Tippbox
|
||||
|
||||
> [!WARNING] I am a warning box
|
||||
> [!WARNING] Ich bin eine Warnbox
|
||||
|
||||
> [!ATTENTION] I am an attention box
|
||||
> [!ATTENTION] Ich bin eine Aufmerksamkeitsbox
|
||||
|
||||
By default, their headers appear in English even in the translated docs.
|
||||
Standardmäßig erscheinen die Kopfzeilen auch in den übersetzten Dokumenten auf Englisch.
|
||||
|
||||
You can have the headers translated in the docs in your language by changing the file `docs/index.html`, in this way:
|
||||
Du kannst die Kopfzeilen in den Dokumenten in deine Sprache übersetzen lassen, indem du die Datei `docs/index.html` auf diese Weise änderst:
|
||||
|
||||
Inside the `script` element there is an object, find the `flexibleAlerts` property, which has this shape:
|
||||
Innerhalb des `script` Elements gibt es ein Objekt, die `flexibleAlerts` Eigenschaft, die diese Form hat:
|
||||
|
||||
```js
|
||||
flexibleAlerts: {
|
||||
@@ -135,9 +135,9 @@ flexibleAlerts: {
|
||||
}
|
||||
```
|
||||
|
||||
Inside the object of the label property, before the `'/'` property, you would add a new property for your language, like `/i18n/<language>/`.
|
||||
Innerhalb des Objekts der Label-Eigenschaft, vor der `'/'`-Eigenschaft, fügst du eine neue Eigenschaft für deine Sprache hinzu, wie `/i18n/<language>/`.
|
||||
|
||||
For example, adding the translations for Portuguese would appear like this:
|
||||
Das Hinzufügen der Übersetzungen für Portugiesisch würde zum Beispiel so aussehen:
|
||||
|
||||
```js
|
||||
flexibleAlerts: {
|
||||
@@ -168,11 +168,11 @@ flexibleAlerts: {
|
||||
}
|
||||
```
|
||||
|
||||
## How to translate the motivational quotes
|
||||
## Wie man die motivierenden Zitate übersetzt
|
||||
|
||||
The motivational quotes can be found in the [curriculum repository](https://github.com/freeCodeCamp/freeCodeCamp/) in the `/client/i18n/locales/<language>/motivation.json` file.
|
||||
Die motivierenden Zitate befinden sich im [Curriculum-Repository](https://github.com/freeCodeCamp/freeCodeCamp/) in der Datei `/client/i18n/locales/<language>/motivation.json`.
|
||||
|
||||
This file has a general structure of:
|
||||
Diese Datei hat folgende allgemeine Struktur:
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -181,11 +181,11 @@ This file has a general structure of:
|
||||
}
|
||||
```
|
||||
|
||||
The compliments are the short sentences that appear at the completion of a challenge.
|
||||
Die Komplimente sind die kurzen Sätze, die am Ende einer Aufgabe erscheinen.
|
||||
|
||||
You don't need to directly translate the sentences used in English, you can write a set of short sentences that are appropriate to show at the completion of a challenge.
|
||||
Du musst die Sätze nicht direkt aus dem Englischen übersetzen, sondern kannst eine Reihe von kurzen Sätzen schreiben, die sich eignen, um sie am Ende einer Aufgabe zu zeigen.
|
||||
|
||||
The `compliments` array is an array of strings, so for example you would write:
|
||||
Das `compliments`-Array ist ein Array aus Strings, also würdest du zum Beispiel schreiben:
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -194,11 +194,11 @@ The `compliments` array is an array of strings, so for example you would write:
|
||||
}
|
||||
```
|
||||
|
||||
> [!TIP] You should start with at least a dozen compliments to have some variety when users complete challenges.
|
||||
> [!TIP] Du solltest mit mindestens einem Dutzend Komplimenten beginnen, um eine gewisse Abwechslung zu schaffen, wenn die Benutzer die Aufgaben abschließen.
|
||||
|
||||
The motivational quotes are the quotes that appear at https://freecodecamp.org/learn.
|
||||
Die Motivationszitate sind die Zitate, die auf https://freecodecamp.org/learn erscheinen.
|
||||
|
||||
The `motivationalQuotes` array is an array of objects, these objects should include a `quote` property and an `author` property. like this:
|
||||
Das `motivationalQuotes`-Array ist ein Array aus Objekten. Diese Objekte sollten eine `quote`-Eigenschaft und eine `author`-Eigenschaft enthalten. Wie hier:
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -216,64 +216,64 @@ The `motivationalQuotes` array is an array of objects, these objects should incl
|
||||
}
|
||||
```
|
||||
|
||||
> [!TIP] You should start with at least a dozen quotes, to have some variety. A new quote is shown every time the user reload the page.
|
||||
> [!TIP] Du solltest mit mindestens einem Dutzend Zitaten beginnen, um eine gewisse Vielfalt zu haben. Jedes Mal, wenn der Benutzer die Seite neu lädt, wird ein neues Zitat angezeigt.
|
||||
|
||||
## How to update the common links
|
||||
## Wie man allgemeine Links aktualisiert
|
||||
|
||||
We maintain a file of common links used throughout our [curriculum site](https://github.com/freecodecamp/freecodecamp) in the `/client/i18n/locales/<language>/links.json` file.
|
||||
In der Datei `/client/i18n/locales/<language>/links.json` wird eine Datei mit allgemeinen Links geführt, die auf unserer [Lehrplan-Website](https://github.com/freecodecamp/freecodecamp) verwendet wird.
|
||||
|
||||
Some of these links will not change - but you should update the `/news` article links to point to your language's translated version of that article when it is published.
|
||||
Einige dieser Links werden sich nicht ändern - aber du solltest die `/news`-Artikel-Links aktualisieren, damit sie auf die übersetzte Version des Artikels in deiner Sprache verweisen, wenn er veröffentlicht wird.
|
||||
|
||||
You should also update the `help` categories to point to your language's subforum (usually `language/category`, like `Italiano/HTML-CSS`). This will allow campers to create "help posts" in the correct forum location.
|
||||
Du solltest auch die `help`-Kategorien aktualisieren, um auf das Unterforum deiner Sprache zu verweisen (normalerweise `language/category`, wie `Italiano/HTML-CSS`). Dies ermöglicht es freeCodeCamp-Benutzern, 'Hilfeanfragen' im richtigen Forum zu erstellen.
|
||||
|
||||
## How to update the site meta-data
|
||||
## So aktualisierst du die Metadaten der Website
|
||||
|
||||
The site meta-data is in the `/client/i18n/locales/<language>/meta-tags.json` file. This file has five keys: `title`, `description`, `social-description`, `keywords`, and `youre-unsubscribed`.
|
||||
Die Metadaten der Website befinden sich in der Datei `/client/i18n/locales/<language>/meta-tags.json`. Diese Datei hat 5 Schlüssel:`title`, `description`, `social-description`, `keywords`, und `youre-unsubscribed`.
|
||||
|
||||
The `youre-unsubscribed` value should be directly translated. The other values will need to be translated as closely as possible, while also considering common search terms and phrases used in your language.
|
||||
Der Wert `youre-unsubscribed` sollte direkt übersetzt werden. Die anderen Werte müssen so genau wie möglich übersetzt werden, wobei auch die in deiner Sprache üblichen Suchbegriffe und Phrasen berücksichtigt werden müssen.
|
||||
|
||||
If you need help with this, reach out to us in the [contributor chat](https://discord.gg/PRyKn3Vbay)
|
||||
Wenn du dabei Hilfe benötigst, wende dich an uns im ["Contributor" Chat](https://discord.gg/PRyKn3Vbay)
|
||||
|
||||
## Pre-Translate Workflow on Crowdin
|
||||
## Vorübersetzungs-Workflow auf Crowdin
|
||||
|
||||
The Pre-Translate workflow can be used to apply translations from the Translation Memory to strings.
|
||||
Der Vorübersetzungs-Workflow kann verwendet werden, um Übersetzungen aus dem Translation Memory auf Strings anzuwenden.
|
||||
|
||||
> [!TIP] Really useful to restore a lot of translations from the Translation Memory in bulk when a lot of files have been updated.
|
||||
> [!TIP] Diese Funktion ist sehr nützlich, um viele Übersetzungen aus dem Translation Memory in großen Mengen wiederherzustellen, wenn viele Dateien aktualisiert worden sind.
|
||||
|
||||
You can find the Pre-Translation workflow at the top of the page in the console of a project. If you see "Go to console" in the upper right corner, click there first.
|
||||
Du findest den Vorübersetzungs-Workflow oben auf der Seite in der Konsole eines Projekts. Wenn du in der oberen rechten Ecke "Go to console" siehst, klicke zuerst darauf.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
You can choose "From Machine Translation" or "From Translation Memory". Choose "Translation Memory" to recover translations from memory.
|
||||
Du kannst "From Machine Translation" oder "From Translation Memory" wählen. Wähle "Translation Memory", um Übersetzungen aus dem Speicher wiederherzustellen.
|
||||
|
||||
Then there are three steps to complete:
|
||||
Dann sind drei Schritte zu absolvieren:
|
||||
|
||||
1. Files. Choose which files to translate, you can do all the project, or specific folders or files.
|
||||
2. Languages. Set your language here.
|
||||
3. Existing Translations. The best combination here is "100% match" and "Apply to untranslated strings only". Do not approve automatically, as it's always best to have a human eye on things.
|
||||
1. Dateien. Wähle die zu übersetzenden Dateien aus. Du kannst das gesamte Projekt oder bestimmte Ordner oder Dateien übersetzen.
|
||||
2. Sprachen. Stelle hier deine Sprache ein.
|
||||
3. Vorhandene Übersetzungen. Die beste Kombination ist hier "100% match" und "Apply to untranslated strings only". Genehmige nicht automatisch, denn es ist immer besser, ein menschliches Auge auf die Dinge zu werfen.
|
||||
|
||||
|
||||
|
||||
|
||||
When you have finished setting this, press the Pre-Translate button and wait. It will alert you once it has finished. The time it takes depends on how many untranslated strings are in the chosen files.
|
||||
Wenn du diese Einstellung abgeschlossen hast, drücke den Button Pre-Translate und warte. Sobald der Vorgang abgeschlossen ist, wirst du benachrichtigt. Wie lange das dauert, hängt davon ab, wie viele unübersetzte Strings in den ausgewählten Dateien enthalten sind.
|
||||
|
||||
## How to update Crowdin Glossary
|
||||
## Wie man das Crowdin Glossar aktualisiert
|
||||
|
||||
> [!TIP] An updated glossary helps in having an homogeneous translation of technical terms.
|
||||
> [!TIP] Ein aktualisiertes Glossar hilft, eine einheitliche Übersetzung von Fachbegriffen zu erhalten.
|
||||
|
||||
The Crowdin Glossary is kept in the [crowdin-glossaries](https://github.com/freeCodeCamp/crowdin-glossaries) repository.
|
||||
Das Crowdin-Glossar wird im [crowdin-glossaries](https://github.com/freeCodeCamp/crowdin-glossaries)-Repository aufbewahrt.
|
||||
|
||||
In the `glossaries` folder there are various `*.csv` (comma separated values) files, one for each of the crowdin projects that have a glossary that can be updated from this workflow.
|
||||
Im Ordner `glossaries` befinden sich verschiedene `*.csv`-Dateien (kommagetrennte Werte), eine für jedes Crowdin-Projekt, das ein Glossar hat, das über diesen Workflow aktualisiert werden kann.
|
||||
|
||||
The `client.csv` file is for the Learn User Interface project, the `curriculum.csv` file is for the Coding Curriculum project, the `docs.csv` file is for the Contributing Documentation project.
|
||||
Die `client.csv`-Datei ist für das Projekt "Learn User Interface", die `curriculum.csv`-Datei ist für das Projekt "Coding Curriculum", die `docs.csv`-Datei ist für das Projekt "Contributing Documentation".
|
||||
|
||||
To update the Crowdin Glossaries you need to clone this repo locally. Open the `.csv` file with an appropriate program, for example Microsoft Excel.
|
||||
Um die Crowdin Glossare zu aktualisieren, musst du dieses Repo lokal klonen. Öffnen die `.csv`-Datei mit einem geeigneten Programm, zum Beispiel Microsoft Excel.
|
||||
|
||||
In the `.csv` file you will find that the English language occupies the first three columns, `Term:English` is the column for the English term, `Description:English` is the column for the English description, and `Part:English` is for the part of speech (e.g., noun, verb etc.) of the term.
|
||||
In der `.csv`-Datei siehst du, dass die englische Sprache die ersten drei Spalten belegt, `Term:English` ist die Spalte für den englischen Begriff, `Description:English` ist die Spalte für die englische Beschreibung, und `Part:English` steht für die Wortart (z. B. Substantiv, Verb usw.) des Begriffs.
|
||||
|
||||
Then, each target language has two columns. If you translate to Dothraki, you will be interested in the columns `Term:Dothraki` and `Description:Dothraki`. The column `Term:Dothraki` is for the translation of the term in Dothraki, and the column `Description:Dothraki` is for a description of the term in Dothraki.
|
||||
Dann hat jede Zielsprache zwei Spalten. Wenn du ins Dothrakische übersetzt, wirst du an den Spalten `Term:Dothraki` und `Description:Dothraki` interessiert sein. Die Spalte `Term:Dothraki` ist für die Übersetzung des Begriffs in Dothraki, und die Spalte `Description:Dothraki` ist für die Beschreibung des Begriffs in Dothraki.
|
||||
|
||||
> [!TIP] In programs like Microsoft Excel you can hide the columns of the other languages to free up screen real-estate and see the English columns and the target language columns near each other.
|
||||
> [!TIP] In Programmen wie Microsoft Excel kannst du die Spalten der anderen Sprachen ausblenden, um Bildschirmfläche freizugeben und die englischen Spalten und die Spalten der Zielsprache nebeneinander zu sehen.
|
||||
|
||||
After you have made the changes and saved the file, you will need to make a PR with the proposed changes. After the PR is accepted, you will need to run the GitHub Action workflow to update the Crowdin Glossary. Your glossary changes will not have immediate effects, but they will come.
|
||||
Nachdem du die Änderungen vorgenommen und die Datei gespeichert hast, musst du einen PR mit den vorgeschlagenen Änderungen erstellen. Nachdem der PR angenommen wurde, musst du den GitHub Action-Workflow ausführen, um das Crowdin-Glossar zu aktualisieren. Deine Änderungen im Glossar werden sich nicht sofort auswirken, aber sie werden kommen.
|
||||
|
||||
@@ -6,6 +6,6 @@ Auch wenn wir im Moment keine Belohnungen oder Swags anbieten, sind wir diesen g
|
||||
|
||||
- Mehul Mohan from [codedamn](https://codedamn.com) ([@mehulmpt](https://twitter.com/mehulmpt)) - [Behebung von Sicherheitslücken](https://github.com/freeCodeCamp/freeCodeCamp/blob/bb5a9e815313f1f7c91338e171bfe5acb8f3e346/client/src/components/Flash/index.js)
|
||||
- Peter Samir https://www.linkedin.com/in/peter-samir/
|
||||
- Laurence Tennant ([@hyperreality](https://github.com/hyperreality)) working with IncludeSecurity.com - [GHSA-cc3r-grh4-27gj](https://github.com/freeCodeCamp/freeCodeCamp/security/advisories/GHSA-cc3r-grh4-27gj)
|
||||
- Laurence Tennant ([@hyperreality](https://github.com/hyperreality)) arbeitet mit IncludeSecurity.com - [GHSA-cc3r-grh4-27gj](https://github.com/freeCodeCamp/freeCodeCamp/security/advisories/GHSA-cc3r-grh4-27gj)
|
||||
|
||||
> ### Thank you for your contributions :pray:
|
||||
> ### Vielen Dank für eure Beiträge :pray:
|
||||
|
||||
@@ -19,11 +19,10 @@
|
||||
- [Lavorare sulla documentazione](how-to-work-on-the-docs-theme.md)
|
||||
- [Lavorare sulla libreria dei componenti](how-to-work-on-the-component-library.md)
|
||||
- **Guide aggiuntive**
|
||||
- [Testare traduzioni in locale](how-to-test-translations-locally.md)
|
||||
- [Capire la struttura dei file del curriculum](curriculum-file-structure.md)
|
||||
- [Fare il debug delle email in uscita localmente](how-to-catch-outgoing-emails-locally.md)
|
||||
- [Settare freeCodeCamp su Windows (WSL)](how-to-setup-wsl.md)
|
||||
- [Workflow con il Token Utente](user-token-workflow.md)
|
||||
- [Understand the curriculum file structure](curriculum-file-structure.md)
|
||||
- [Debug outgoing emails locally](how-to-catch-outgoing-emails-locally.md)
|
||||
- [Set up freeCodeCamp on Windows (WSL)](how-to-setup-wsl.md)
|
||||
- [User Token Workflow](user-token-workflow.md)
|
||||
|
||||
---
|
||||
|
||||
@@ -32,6 +31,7 @@
|
||||
- [Manuale del Leader di lingua](language-lead-handbook.md)
|
||||
- [Manuale di DevOps](devops.md)
|
||||
- [Estensione di VSCode per i corsi](courses-vscode-extension.md)
|
||||
- [Enable New Language](how-to-enable-new-languages.md)
|
||||
|
||||
---
|
||||
|
||||
|
||||
279
docs/i18n/italian/how-to-enable-new-languages.md
Normal file
279
docs/i18n/italian/how-to-enable-new-languages.md
Normal file
@@ -0,0 +1,279 @@
|
||||
# Deploying New Languages on `/learn`
|
||||
|
||||
Before you can release a new language, you will need to allow the languages to download from Crowdin.
|
||||
|
||||
## Updating Crowdin Settings
|
||||
|
||||
In the `Curriculum` and `Learn UI` projects, you will need to select `Project Settings` from the sidebar. Then scroll down to `Language Mapping`, where you will see an option to add custom language codes. Add a new entry for the language you are releasing, selecting `language` as the `Placeholder` value, and entering a URL-friendly lower-case spelling of your language's name for the `Custom code`. If you aren't sure what to use, reach out in our contributor chat and we will assist you.
|
||||
|
||||
## Updating Workflows
|
||||
|
||||
You will need to add a step to the `crowdin-download.client-ui.yml` and `crowdin-download.curriculum.yml`. The step for these will be the same. For example, if you want to enable Dothraki downloads:
|
||||
|
||||
```yml
|
||||
##### Download Dothraki #####
|
||||
- name: Crowdin Download Dothraki Translations
|
||||
uses: crowdin/github-action@master
|
||||
# options: https://github.com/crowdin/github-action/blob/master/action.yml
|
||||
with:
|
||||
# uploads
|
||||
upload_sources: false
|
||||
upload_translations: false
|
||||
auto_approve_imported: false
|
||||
import_eq_suggestions: false
|
||||
|
||||
# downloads
|
||||
download_translations: true
|
||||
download_language: mis
|
||||
skip_untranslated_files: false
|
||||
export_only_approved: true
|
||||
|
||||
push_translations: false
|
||||
|
||||
# pull-request
|
||||
create_pull_request: false
|
||||
|
||||
# global options
|
||||
config: './crowdin-config.yml'
|
||||
base_url: ${{ secrets.CROWDIN_BASE_URL_FCC }}
|
||||
|
||||
# Uncomment below to debug
|
||||
# dryrun_action: true
|
||||
```
|
||||
|
||||
Note that the `download_language` key needs to be set to the language code displayed on Crowdin.
|
||||
|
||||
## Enabling a Language
|
||||
|
||||
> [!NOTE] The above section with updating the workflows should be completed before proceeding - these need to be done in separate steps or the builds will fail.
|
||||
|
||||
There are a few steps to take in order to allow the codebase to build in your desired language.
|
||||
|
||||
First, visit the `config/i18n/all-langs.ts` file to add the language to the available languages list and configure the values. There are several objects here.
|
||||
|
||||
- `availableLangs`: For both the `client` and `curriculum` arrays, add the text name of the language. This is the value that will be used in the `.env` file later.
|
||||
- `auditedCerts`: Add the text name of the language as the _key_, and add an array of `SuperBlocks.{cert}` variables as the _value_. This tells the client which certifications are fully translated.
|
||||
- `i18nextCodes`: These are the ISO language codes for each language. You will need to add the appropriate ISO code for the language you are enabling. These do need to be unique for each language.
|
||||
- `LangNames`: These are the display names for the language selector in the navigation menu.
|
||||
- `LangCodes`: These are the language codes used for formatting dates and numbers. These should be Unicode CLDR codes instead of ISO codes.
|
||||
- `hiddenLangs`: These languages will not be displayed in the navigation menu. This is used for languages that are not yet ready for release.
|
||||
|
||||
As an example, if you wanted to enable Dothraki as a language, your `all-langs.js` objects should look like this:
|
||||
|
||||
```js
|
||||
export const availableLangs = {
|
||||
client: ['english', 'espanol', 'chinese', 'chinese-traditional', 'dothraki'],
|
||||
curriculum: [
|
||||
'english',
|
||||
'espanol',
|
||||
'chinese',
|
||||
'chinese-traditional',
|
||||
'dothraki'
|
||||
]
|
||||
};
|
||||
|
||||
export const auditedCerts = {
|
||||
espanol: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis
|
||||
],
|
||||
chinese: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis,
|
||||
SuperBlocks.QualityAssurance,
|
||||
SuperBlocks.SciCompPy,
|
||||
SuperBlocks.DataAnalysisPy,
|
||||
SuperBlocks.InfoSec,
|
||||
SuperBlocks.MachineLearningPy
|
||||
],
|
||||
'chinese-traditional': [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis,
|
||||
SuperBlocks.QualityAssurance,
|
||||
SuperBlocks.SciCompPy,
|
||||
SuperBlocks.DataAnalysisPy,
|
||||
SuperBlocks.InfoSec,
|
||||
SuperBlocks.MachineLearningPy
|
||||
],
|
||||
dothraki: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs
|
||||
]
|
||||
};
|
||||
|
||||
export const i18nextCodes = {
|
||||
english: 'en',
|
||||
espanol: 'es',
|
||||
chinese: 'zh',
|
||||
'chinese-traditional': 'zh-Hant',
|
||||
dothraki: 'mis'
|
||||
};
|
||||
|
||||
export enum LangNames = {
|
||||
english: 'English',
|
||||
espanol: 'Español',
|
||||
chinese: '中文（简体字）',
|
||||
'chinese-traditional': '中文（繁體字）',
|
||||
dothraki: 'Dothraki'
|
||||
};
|
||||
|
||||
export enum LangCodes = {
|
||||
english: 'en-US',
|
||||
espanol: 'es-419',
|
||||
chinese: 'zh',
|
||||
'chinese-traditional': 'zh-Hant',
|
||||
dothraki: 'mis'
|
||||
};
|
||||
|
||||
export const hiddenLangs = ['dothraki'];
|
||||
```
|
||||
|
||||
> [!NOTE] When a language has been set up in the deployment pipeline AND has a public `/news` instance live, it can be removed from the `hiddenLangs` array and be made available to the public.
|
||||
|
||||
Next, open the `client/src/utils/algolia-locale-setup.ts` file. This data is used for the search bar that loads `/news` articles. While it is unlikely that you are going to test this functionality, missing the data for your language can lead to errors when attempting to build the codebase locally.
|
||||
|
||||
Add an object for your language to the `algoliaIndices` object. You should use the the same values as the `english` object for local testing, replacing the `english` key with your language's `availableLangs` value.
|
||||
|
||||
> [!NOTE] If we have already deployed an instance of news in your target language, you can update the values to reflect the live instance. Otherwise, use the English values.
|
||||
|
||||
If you were to add Dothraki:
|
||||
|
||||
```js
|
||||
const algoliaIndices = {
|
||||
english: {
|
||||
name: 'news',
|
||||
searchPage: 'https://www.freecodecamp.org/news/search/'
|
||||
},
|
||||
espanol: {
|
||||
name: 'news-es',
|
||||
searchPage: 'https://www.freecodecamp.org/espanol/news/search/'
|
||||
},
|
||||
chinese: {
|
||||
name: 'news-zh',
|
||||
searchPage: 'https://chinese.freecodecamp.org/news/search/'
|
||||
},
|
||||
'chinese-traditional': {
|
||||
name: 'news-zh',
|
||||
searchPage: 'https://chinese.freecodecamp.org/news/search'
|
||||
},
|
||||
dothraki: {
|
||||
name: 'news',
|
||||
searchPage: 'https://www.freecodecamp.org/news/search/'
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
### Releasing a Superblock
|
||||
|
||||
After a superblock has been fully translated into a language, there are two steps to release it. First add the superblock enum to that language's `auditedCerts` array. So, if you want to release the new Responsive Web Design superblock for Dothraki, the array should look like this:
|
||||
|
||||
```ts
|
||||
export const auditedCerts = {
|
||||
// other languages
|
||||
dothraki: [
|
||||
SuperBlocks.RespWebDesignNew, // the newly translated superblock
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs
|
||||
]
|
||||
};
|
||||
```
|
||||
|
||||
Finally, if the superblock is in a "new" state (that is, replacing a legacy superblock), the `languagesWithAuditedBetaReleases` array should be updated to include the new language like this:
|
||||
|
||||
```ts
|
||||
export const languagesWithAuditedBetaReleases: ['english', 'dothraki'];
|
||||
```
|
||||
|
||||
This will move the new superblock to the correct place in the curriculum map on `/learn`.
|
||||
|
||||
## Enabling Localized Videos
|
||||
|
||||
For the video challenges, you need to change a few things. First add the new locale to the GraphQL query in the `client/src/templates/Challenges/video/Show.tsx` file. For example, adding Dothraki to the query:
|
||||
|
||||
```tsx
|
||||
query VideoChallenge($slug: String!) {
|
||||
challengeNode(fields: { slug: { eq: $slug } }) {
|
||||
videoId
|
||||
videoLocaleIds {
|
||||
espanol
|
||||
italian
|
||||
portuguese
|
||||
dothraki
|
||||
}
|
||||
...
|
||||
```
|
||||
|
||||
Then add an id for the new language to any video challenge in an audited block. For example, if `auditedCerts` in `all-langs.ts` includes `scientific-computing-with-python` for `dothraki`, then you must add a `dothraki` entry in `videoLocaleIds`. The frontmatter should then look like this:
|
||||
|
||||
```yml
|
||||
videoLocaleIds:
|
||||
espanol: 3muQV-Im3Z0
|
||||
italian: hiRTRAqNlpE
|
||||
portuguese: AelGAcoMXbI
|
||||
dothraki: new-id-here
|
||||
dashedName: introduction-why-program
|
||||
---
|
||||
```
|
||||
|
||||
Update the `VideoLocaleIds` interface in `client/src/redux/prop-types` to include the new language.
|
||||
|
||||
```ts
|
||||
export interface VideoLocaleIds {
|
||||
espanol?: string;
|
||||
italian?: string;
|
||||
portuguese?: string;
|
||||
dothraki?: string;
|
||||
}
|
||||
```
|
||||
|
||||
And finally update the challenge schema in `curriculum/schema/challengeSchema.js`.
|
||||
|
||||
```js
|
||||
videoLocaleIds: Joi.when('challengeType', {
|
||||
is: challengeTypes.video,
|
||||
then: Joi.object().keys({
|
||||
espanol: Joi.string(),
|
||||
italian: Joi.string(),
|
||||
portuguese: Joi.string(),
|
||||
dothraki: Joi.string()
|
||||
})
|
||||
}),
|
||||
```
|
||||
|
||||
## Client UI
|
||||
|
||||
You will need to take an additional step to handle the client UI translations.
|
||||
|
||||
The Crowdin workflows will automatically pull down _some_ of the UI translations, but there are a couple of files that need to be moved manually.
|
||||
|
||||
You will want to copy the following files from `/client/i18n/locales/english` to `/client/i18n/locales/<your-language>`, and apply translations as needed:
|
||||
|
||||
- `links.json`
|
||||
- `meta-tags.json`
|
||||
- `motivation.json`
|
||||
- `trending.json`
|
||||
|
||||
## Testing Translations Locally
|
||||
|
||||
If you would like to test translations locally, before adding them to our main repository - skip the Crowdin workflow changes. Follow the steps for enabling a language, then download the translations from Crowdin and load them into your local code.
|
||||
|
||||
Because the language has not been approved for production, our scripts are not automatically downloading the translations yet. Only staff have the access to directly download the translations - you are welcome to reach out to us in our [contributors chat room](https://discord.gg/PRyKn3Vbay), or you can translate the English markdown files locally for testing purposes.
|
||||
|
||||
Once you have the files, you will need to place them in the correct directory. For the curriculum challenges, you should place the certification folders (i.e. `01-responsive-web-design`) within the `curriculum/challenges/{lang}` directory. For our Dothraki translations, this would be `curriculum/challenges/dothraki`. The client translation `.json` files will go in the `client/i18n/locales/{lang}` directory.
|
||||
|
||||
Update your `.env` file to use your new language for `CLIENT_LOCALE` and `CURRICULUM_LOCALE`.
|
||||
|
||||
Once these are in place, you should be able to run `npm run develop` to view your translated version of freeCodeCamp.
|
||||
|
||||
> [!ATTENTION] While you may perform translations locally for the purpose of testing, we remind everyone that translations should _not_ be submitted through GitHub and should only be done through Crowdin. Be sure to reset your local codebase after you are done testing.
|
||||
@@ -65,7 +65,7 @@ Questo è un esempio di come deve essere una parte del file `trending.json`.
|
||||
}
|
||||
```
|
||||
|
||||
Dovrai [fare il build in locale del client tradotto](how-to-test-translations-locally.md) per vedere se i titoli hanno la giusta lunghezza. Ogni titolo deve rimanere su una sola riga e non andare sulla successiva.
|
||||
You will want to [build the translated client locally](how-to-enable-new-languages.md) to see if the titles have the right length. Ogni titolo deve rimanere su una sola riga e non andare sulla successiva.
|
||||
|
||||
### Come aggiornare gli articoli di tendenza nel cdn
|
||||
|
||||
|
||||
@@ -19,11 +19,10 @@
|
||||
- [ドキュメントに貢献する](how-to-work-on-the-docs-theme.md)
|
||||
- [コンポーネントライブラリに貢献する](how-to-work-on-the-component-library.md)
|
||||
- **その他のガイド**
|
||||
- [翻訳をローカルでテストする](how-to-test-translations-locally.md)
|
||||
- [カリキュラムのファイル構造を理解する](curriculum-file-structure.md)
|
||||
- [送信メールをローカルでデバッグする](how-to-catch-outgoing-emails-locally.md)
|
||||
- [Windows (WSL) で freeCodeCamp 開発環境を構築する](how-to-setup-wsl.md)
|
||||
- [ユーザートークンワークフロー](user-token-workflow.md)
|
||||
- [Understand the curriculum file structure](curriculum-file-structure.md)
|
||||
- [Debug outgoing emails locally](how-to-catch-outgoing-emails-locally.md)
|
||||
- [Set up freeCodeCamp on Windows (WSL)](how-to-setup-wsl.md)
|
||||
- [User Token Workflow](user-token-workflow.md)
|
||||
|
||||
---
|
||||
|
||||
@@ -32,6 +31,7 @@
|
||||
- [ランゲージリードハンドブック](language-lead-handbook.md)
|
||||
- [DevOps ハンドブック](devops.md)
|
||||
- [VSCode 拡張機能「Courses」](courses-vscode-extension.md)
|
||||
- [Enable New Language](how-to-enable-new-languages.md)
|
||||
|
||||
---
|
||||
|
||||
|
||||
279
docs/i18n/japanese/how-to-enable-new-languages.md
Normal file
279
docs/i18n/japanese/how-to-enable-new-languages.md
Normal file
@@ -0,0 +1,279 @@
|
||||
# Deploying New Languages on `/learn`
|
||||
|
||||
Before you can release a new language, you will need to allow the languages to download from Crowdin.
|
||||
|
||||
## Updating Crowdin Settings
|
||||
|
||||
In the `Curriculum` and `Learn UI` projects, you will need to select `Project Settings` from the sidebar. Then scroll down to `Language Mapping`, where you will see an option to add custom language codes. Add a new entry for the language you are releasing, selecting `language` as the `Placeholder` value, and entering a URL-friendly lower-case spelling of your language's name for the `Custom code`. If you aren't sure what to use, reach out in our contributor chat and we will assist you.
|
||||
|
||||
## Updating Workflows
|
||||
|
||||
You will need to add a step to the `crowdin-download.client-ui.yml` and `crowdin-download.curriculum.yml`. The step for these will be the same. For example, if you want to enable Dothraki downloads:
|
||||
|
||||
```yml
|
||||
##### Download Dothraki #####
|
||||
- name: Crowdin Download Dothraki Translations
|
||||
uses: crowdin/github-action@master
|
||||
# options: https://github.com/crowdin/github-action/blob/master/action.yml
|
||||
with:
|
||||
# uploads
|
||||
upload_sources: false
|
||||
upload_translations: false
|
||||
auto_approve_imported: false
|
||||
import_eq_suggestions: false
|
||||
|
||||
# downloads
|
||||
download_translations: true
|
||||
download_language: mis
|
||||
skip_untranslated_files: false
|
||||
export_only_approved: true
|
||||
|
||||
push_translations: false
|
||||
|
||||
# pull-request
|
||||
create_pull_request: false
|
||||
|
||||
# global options
|
||||
config: './crowdin-config.yml'
|
||||
base_url: ${{ secrets.CROWDIN_BASE_URL_FCC }}
|
||||
|
||||
# Uncomment below to debug
|
||||
# dryrun_action: true
|
||||
```
|
||||
|
||||
Note that the `download_language` key needs to be set to the language code displayed on Crowdin.
|
||||
|
||||
## Enabling a Language
|
||||
|
||||
> [!NOTE] The above section with updating the workflows should be completed before proceeding - these need to be done in separate steps or the builds will fail.
|
||||
|
||||
There are a few steps to take in order to allow the codebase to build in your desired language.
|
||||
|
||||
First, visit the `config/i18n/all-langs.ts` file to add the language to the available languages list and configure the values. There are several objects here.
|
||||
|
||||
- `availableLangs`: For both the `client` and `curriculum` arrays, add the text name of the language. This is the value that will be used in the `.env` file later.
|
||||
- `auditedCerts`: Add the text name of the language as the _key_, and add an array of `SuperBlocks.{cert}` variables as the _value_. This tells the client which certifications are fully translated.
|
||||
- `i18nextCodes`: These are the ISO language codes for each language. You will need to add the appropriate ISO code for the language you are enabling. These do need to be unique for each language.
|
||||
- `LangNames`: These are the display names for the language selector in the navigation menu.
|
||||
- `LangCodes`: These are the language codes used for formatting dates and numbers. These should be Unicode CLDR codes instead of ISO codes.
|
||||
- `hiddenLangs`: These languages will not be displayed in the navigation menu. This is used for languages that are not yet ready for release.
|
||||
|
||||
As an example, if you wanted to enable Dothraki as a language, your `all-langs.js` objects should look like this:
|
||||
|
||||
```js
|
||||
export const availableLangs = {
|
||||
client: ['english', 'espanol', 'chinese', 'chinese-traditional', 'dothraki'],
|
||||
curriculum: [
|
||||
'english',
|
||||
'espanol',
|
||||
'chinese',
|
||||
'chinese-traditional',
|
||||
'dothraki'
|
||||
]
|
||||
};
|
||||
|
||||
export const auditedCerts = {
|
||||
espanol: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis
|
||||
],
|
||||
chinese: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis,
|
||||
SuperBlocks.QualityAssurance,
|
||||
SuperBlocks.SciCompPy,
|
||||
SuperBlocks.DataAnalysisPy,
|
||||
SuperBlocks.InfoSec,
|
||||
SuperBlocks.MachineLearningPy
|
||||
],
|
||||
'chinese-traditional': [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis,
|
||||
SuperBlocks.QualityAssurance,
|
||||
SuperBlocks.SciCompPy,
|
||||
SuperBlocks.DataAnalysisPy,
|
||||
SuperBlocks.InfoSec,
|
||||
SuperBlocks.MachineLearningPy
|
||||
],
|
||||
dothraki: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs
|
||||
]
|
||||
};
|
||||
|
||||
export const i18nextCodes = {
|
||||
english: 'en',
|
||||
espanol: 'es',
|
||||
chinese: 'zh',
|
||||
'chinese-traditional': 'zh-Hant',
|
||||
dothraki: 'mis'
|
||||
};
|
||||
|
||||
export enum LangNames = {
|
||||
english: 'English',
|
||||
espanol: 'Español',
|
||||
chinese: '中文（简体字）',
|
||||
'chinese-traditional': '中文（繁體字）',
|
||||
dothraki: 'Dothraki'
|
||||
};
|
||||
|
||||
export enum LangCodes = {
|
||||
english: 'en-US',
|
||||
espanol: 'es-419',
|
||||
chinese: 'zh',
|
||||
'chinese-traditional': 'zh-Hant',
|
||||
dothraki: 'mis'
|
||||
};
|
||||
|
||||
export const hiddenLangs = ['dothraki'];
|
||||
```
|
||||
|
||||
> [!NOTE] When a language has been set up in the deployment pipeline AND has a public `/news` instance live, it can be removed from the `hiddenLangs` array and be made available to the public.
|
||||
|
||||
Next, open the `client/src/utils/algolia-locale-setup.ts` file. This data is used for the search bar that loads `/news` articles. While it is unlikely that you are going to test this functionality, missing the data for your language can lead to errors when attempting to build the codebase locally.
|
||||
|
||||
Add an object for your language to the `algoliaIndices` object. You should use the the same values as the `english` object for local testing, replacing the `english` key with your language's `availableLangs` value.
|
||||
|
||||
> [!NOTE] If we have already deployed an instance of news in your target language, you can update the values to reflect the live instance. Otherwise, use the English values.
|
||||
|
||||
If you were to add Dothraki:
|
||||
|
||||
```js
|
||||
const algoliaIndices = {
|
||||
english: {
|
||||
name: 'news',
|
||||
searchPage: 'https://www.freecodecamp.org/news/search/'
|
||||
},
|
||||
espanol: {
|
||||
name: 'news-es',
|
||||
searchPage: 'https://www.freecodecamp.org/espanol/news/search/'
|
||||
},
|
||||
chinese: {
|
||||
name: 'news-zh',
|
||||
searchPage: 'https://chinese.freecodecamp.org/news/search/'
|
||||
},
|
||||
'chinese-traditional': {
|
||||
name: 'news-zh',
|
||||
searchPage: 'https://chinese.freecodecamp.org/news/search'
|
||||
},
|
||||
dothraki: {
|
||||
name: 'news',
|
||||
searchPage: 'https://www.freecodecamp.org/news/search/'
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
### Releasing a Superblock
|
||||
|
||||
After a superblock has been fully translated into a language, there are two steps to release it. First add the superblock enum to that language's `auditedCerts` array. So, if you want to release the new Responsive Web Design superblock for Dothraki, the array should look like this:
|
||||
|
||||
```ts
|
||||
export const auditedCerts = {
|
||||
// other languages
|
||||
dothraki: [
|
||||
SuperBlocks.RespWebDesignNew, // the newly translated superblock
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs
|
||||
]
|
||||
};
|
||||
```
|
||||
|
||||
Finally, if the superblock is in a "new" state (that is, replacing a legacy superblock), the `languagesWithAuditedBetaReleases` array should be updated to include the new language like this:
|
||||
|
||||
```ts
|
||||
export const languagesWithAuditedBetaReleases: ['english', 'dothraki'];
|
||||
```
|
||||
|
||||
This will move the new superblock to the correct place in the curriculum map on `/learn`.
|
||||
|
||||
## Enabling Localized Videos
|
||||
|
||||
For the video challenges, you need to change a few things. First add the new locale to the GraphQL query in the `client/src/templates/Challenges/video/Show.tsx` file. For example, adding Dothraki to the query:
|
||||
|
||||
```tsx
|
||||
query VideoChallenge($slug: String!) {
|
||||
challengeNode(fields: { slug: { eq: $slug } }) {
|
||||
videoId
|
||||
videoLocaleIds {
|
||||
espanol
|
||||
italian
|
||||
portuguese
|
||||
dothraki
|
||||
}
|
||||
...
|
||||
```
|
||||
|
||||
Then add an id for the new language to any video challenge in an audited block. For example, if `auditedCerts` in `all-langs.ts` includes `scientific-computing-with-python` for `dothraki`, then you must add a `dothraki` entry in `videoLocaleIds`. The frontmatter should then look like this:
|
||||
|
||||
```yml
|
||||
videoLocaleIds:
|
||||
espanol: 3muQV-Im3Z0
|
||||
italian: hiRTRAqNlpE
|
||||
portuguese: AelGAcoMXbI
|
||||
dothraki: new-id-here
|
||||
dashedName: introduction-why-program
|
||||
---
|
||||
```
|
||||
|
||||
Update the `VideoLocaleIds` interface in `client/src/redux/prop-types` to include the new language.
|
||||
|
||||
```ts
|
||||
export interface VideoLocaleIds {
|
||||
espanol?: string;
|
||||
italian?: string;
|
||||
portuguese?: string;
|
||||
dothraki?: string;
|
||||
}
|
||||
```
|
||||
|
||||
And finally update the challenge schema in `curriculum/schema/challengeSchema.js`.
|
||||
|
||||
```js
|
||||
videoLocaleIds: Joi.when('challengeType', {
|
||||
is: challengeTypes.video,
|
||||
then: Joi.object().keys({
|
||||
espanol: Joi.string(),
|
||||
italian: Joi.string(),
|
||||
portuguese: Joi.string(),
|
||||
dothraki: Joi.string()
|
||||
})
|
||||
}),
|
||||
```
|
||||
|
||||
## Client UI
|
||||
|
||||
You will need to take an additional step to handle the client UI translations.
|
||||
|
||||
The Crowdin workflows will automatically pull down _some_ of the UI translations, but there are a couple of files that need to be moved manually.
|
||||
|
||||
You will want to copy the following files from `/client/i18n/locales/english` to `/client/i18n/locales/<your-language>`, and apply translations as needed:
|
||||
|
||||
- `links.json`
|
||||
- `meta-tags.json`
|
||||
- `motivation.json`
|
||||
- `trending.json`
|
||||
|
||||
## Testing Translations Locally
|
||||
|
||||
If you would like to test translations locally, before adding them to our main repository - skip the Crowdin workflow changes. Follow the steps for enabling a language, then download the translations from Crowdin and load them into your local code.
|
||||
|
||||
Because the language has not been approved for production, our scripts are not automatically downloading the translations yet. Only staff have the access to directly download the translations - you are welcome to reach out to us in our [contributors chat room](https://discord.gg/PRyKn3Vbay), or you can translate the English markdown files locally for testing purposes.
|
||||
|
||||
Once you have the files, you will need to place them in the correct directory. For the curriculum challenges, you should place the certification folders (i.e. `01-responsive-web-design`) within the `curriculum/challenges/{lang}` directory. For our Dothraki translations, this would be `curriculum/challenges/dothraki`. The client translation `.json` files will go in the `client/i18n/locales/{lang}` directory.
|
||||
|
||||
Update your `.env` file to use your new language for `CLIENT_LOCALE` and `CURRICULUM_LOCALE`.
|
||||
|
||||
Once these are in place, you should be able to run `npm run develop` to view your translated version of freeCodeCamp.
|
||||
|
||||
> [!ATTENTION] While you may perform translations locally for the purpose of testing, we remind everyone that translations should _not_ be submitted through GitHub and should only be done through Crowdin. Be sure to reset your local codebase after you are done testing.
|
||||
@@ -65,7 +65,7 @@ This is an example of how part of the `trending.json` file has to look.
|
||||
}
|
||||
```
|
||||
|
||||
You will want to [build the translated client locally](how-to-test-translations-locally.md) to see if the titles have the right length. Each title must stay on a single line and not go to a new line.
|
||||
You will want to [build the translated client locally](how-to-enable-new-languages.md) to see if the titles have the right length. Each title must stay on a single line and not go to a new line.
|
||||
|
||||
### How to update the trending articles in the cdn
|
||||
|
||||
|
||||
@@ -19,11 +19,10 @@
|
||||
- [Trabalhar com a documentação](how-to-work-on-the-docs-theme.md)
|
||||
- [Trabalhar na biblioteca de componentes](how-to-work-on-the-component-library.md)
|
||||
- **Guias adicionais**
|
||||
- [Testar traduções localmente](how-to-test-translations-locally.md)
|
||||
- [Compreender a estrutura do arquivo do currículo](curriculum-file-structure.md)
|
||||
- [Depurar e-mails enviados localmente](how-to-catch-outgoing-emails-locally.md)
|
||||
- [Configurar freeCodeCamp no Windows (WSL)](how-to-setup-wsl.md)
|
||||
- [Fluxo de trabalho do token de usuário](user-token-workflow.md)
|
||||
- [Understand the curriculum file structure](curriculum-file-structure.md)
|
||||
- [Debug outgoing emails locally](how-to-catch-outgoing-emails-locally.md)
|
||||
- [Set up freeCodeCamp on Windows (WSL)](how-to-setup-wsl.md)
|
||||
- [User Token Workflow](user-token-workflow.md)
|
||||
|
||||
---
|
||||
|
||||
@@ -32,6 +31,7 @@
|
||||
- [Manual do líder do idioma](language-lead-handbook.md)
|
||||
- [Manual do DevOps](devops.md)
|
||||
- [Extensão do VSCode Courses](courses-vscode-extension.md)
|
||||
- [Enable New Language](how-to-enable-new-languages.md)
|
||||
|
||||
---
|
||||
|
||||
|
||||
279
docs/i18n/portuguese/how-to-enable-new-languages.md
Normal file
279
docs/i18n/portuguese/how-to-enable-new-languages.md
Normal file
@@ -0,0 +1,279 @@
|
||||
# Deploying New Languages on `/learn`
|
||||
|
||||
Before you can release a new language, you will need to allow the languages to download from Crowdin.
|
||||
|
||||
## Updating Crowdin Settings
|
||||
|
||||
In the `Curriculum` and `Learn UI` projects, you will need to select `Project Settings` from the sidebar. Then scroll down to `Language Mapping`, where you will see an option to add custom language codes. Add a new entry for the language you are releasing, selecting `language` as the `Placeholder` value, and entering a URL-friendly lower-case spelling of your language's name for the `Custom code`. If you aren't sure what to use, reach out in our contributor chat and we will assist you.
|
||||
|
||||
## Updating Workflows
|
||||
|
||||
You will need to add a step to the `crowdin-download.client-ui.yml` and `crowdin-download.curriculum.yml`. The step for these will be the same. For example, if you want to enable Dothraki downloads:
|
||||
|
||||
```yml
|
||||
##### Download Dothraki #####
|
||||
- name: Crowdin Download Dothraki Translations
|
||||
uses: crowdin/github-action@master
|
||||
# options: https://github.com/crowdin/github-action/blob/master/action.yml
|
||||
with:
|
||||
# uploads
|
||||
upload_sources: false
|
||||
upload_translations: false
|
||||
auto_approve_imported: false
|
||||
import_eq_suggestions: false
|
||||
|
||||
# downloads
|
||||
download_translations: true
|
||||
download_language: mis
|
||||
skip_untranslated_files: false
|
||||
export_only_approved: true
|
||||
|
||||
push_translations: false
|
||||
|
||||
# pull-request
|
||||
create_pull_request: false
|
||||
|
||||
# global options
|
||||
config: './crowdin-config.yml'
|
||||
base_url: ${{ secrets.CROWDIN_BASE_URL_FCC }}
|
||||
|
||||
# Uncomment below to debug
|
||||
# dryrun_action: true
|
||||
```
|
||||
|
||||
Note that the `download_language` key needs to be set to the language code displayed on Crowdin.
|
||||
|
||||
## Enabling a Language
|
||||
|
||||
> [!NOTE] The above section with updating the workflows should be completed before proceeding - these need to be done in separate steps or the builds will fail.
|
||||
|
||||
There are a few steps to take in order to allow the codebase to build in your desired language.
|
||||
|
||||
First, visit the `config/i18n/all-langs.ts` file to add the language to the available languages list and configure the values. There are several objects here.
|
||||
|
||||
- `availableLangs`: For both the `client` and `curriculum` arrays, add the text name of the language. This is the value that will be used in the `.env` file later.
|
||||
- `auditedCerts`: Add the text name of the language as the _key_, and add an array of `SuperBlocks.{cert}` variables as the _value_. This tells the client which certifications are fully translated.
|
||||
- `i18nextCodes`: These are the ISO language codes for each language. You will need to add the appropriate ISO code for the language you are enabling. These do need to be unique for each language.
|
||||
- `LangNames`: These are the display names for the language selector in the navigation menu.
|
||||
- `LangCodes`: These are the language codes used for formatting dates and numbers. These should be Unicode CLDR codes instead of ISO codes.
|
||||
- `hiddenLangs`: These languages will not be displayed in the navigation menu. This is used for languages that are not yet ready for release.
|
||||
|
||||
As an example, if you wanted to enable Dothraki as a language, your `all-langs.js` objects should look like this:
|
||||
|
||||
```js
|
||||
export const availableLangs = {
|
||||
client: ['english', 'espanol', 'chinese', 'chinese-traditional', 'dothraki'],
|
||||
curriculum: [
|
||||
'english',
|
||||
'espanol',
|
||||
'chinese',
|
||||
'chinese-traditional',
|
||||
'dothraki'
|
||||
]
|
||||
};
|
||||
|
||||
export const auditedCerts = {
|
||||
espanol: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis
|
||||
],
|
||||
chinese: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis,
|
||||
SuperBlocks.QualityAssurance,
|
||||
SuperBlocks.SciCompPy,
|
||||
SuperBlocks.DataAnalysisPy,
|
||||
SuperBlocks.InfoSec,
|
||||
SuperBlocks.MachineLearningPy
|
||||
],
|
||||
'chinese-traditional': [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis,
|
||||
SuperBlocks.QualityAssurance,
|
||||
SuperBlocks.SciCompPy,
|
||||
SuperBlocks.DataAnalysisPy,
|
||||
SuperBlocks.InfoSec,
|
||||
SuperBlocks.MachineLearningPy
|
||||
],
|
||||
dothraki: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs
|
||||
]
|
||||
};
|
||||
|
||||
export const i18nextCodes = {
|
||||
english: 'en',
|
||||
espanol: 'es',
|
||||
chinese: 'zh',
|
||||
'chinese-traditional': 'zh-Hant',
|
||||
dothraki: 'mis'
|
||||
};
|
||||
|
||||
export enum LangNames = {
|
||||
english: 'English',
|
||||
espanol: 'Español',
|
||||
chinese: '中文（简体字）',
|
||||
'chinese-traditional': '中文（繁體字）',
|
||||
dothraki: 'Dothraki'
|
||||
};
|
||||
|
||||
export enum LangCodes = {
|
||||
english: 'en-US',
|
||||
espanol: 'es-419',
|
||||
chinese: 'zh',
|
||||
'chinese-traditional': 'zh-Hant',
|
||||
dothraki: 'mis'
|
||||
};
|
||||
|
||||
export const hiddenLangs = ['dothraki'];
|
||||
```
|
||||
|
||||
> [!NOTE] When a language has been set up in the deployment pipeline AND has a public `/news` instance live, it can be removed from the `hiddenLangs` array and be made available to the public.
|
||||
|
||||
Next, open the `client/src/utils/algolia-locale-setup.ts` file. This data is used for the search bar that loads `/news` articles. While it is unlikely that you are going to test this functionality, missing the data for your language can lead to errors when attempting to build the codebase locally.
|
||||
|
||||
Add an object for your language to the `algoliaIndices` object. You should use the the same values as the `english` object for local testing, replacing the `english` key with your language's `availableLangs` value.
|
||||
|
||||
> [!NOTE] If we have already deployed an instance of news in your target language, you can update the values to reflect the live instance. Otherwise, use the English values.
|
||||
|
||||
If you were to add Dothraki:
|
||||
|
||||
```js
|
||||
const algoliaIndices = {
|
||||
english: {
|
||||
name: 'news',
|
||||
searchPage: 'https://www.freecodecamp.org/news/search/'
|
||||
},
|
||||
espanol: {
|
||||
name: 'news-es',
|
||||
searchPage: 'https://www.freecodecamp.org/espanol/news/search/'
|
||||
},
|
||||
chinese: {
|
||||
name: 'news-zh',
|
||||
searchPage: 'https://chinese.freecodecamp.org/news/search/'
|
||||
},
|
||||
'chinese-traditional': {
|
||||
name: 'news-zh',
|
||||
searchPage: 'https://chinese.freecodecamp.org/news/search'
|
||||
},
|
||||
dothraki: {
|
||||
name: 'news',
|
||||
searchPage: 'https://www.freecodecamp.org/news/search/'
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
### Releasing a Superblock
|
||||
|
||||
After a superblock has been fully translated into a language, there are two steps to release it. First add the superblock enum to that language's `auditedCerts` array. So, if you want to release the new Responsive Web Design superblock for Dothraki, the array should look like this:
|
||||
|
||||
```ts
|
||||
export const auditedCerts = {
|
||||
// other languages
|
||||
dothraki: [
|
||||
SuperBlocks.RespWebDesignNew, // the newly translated superblock
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs
|
||||
]
|
||||
};
|
||||
```
|
||||
|
||||
Finally, if the superblock is in a "new" state (that is, replacing a legacy superblock), the `languagesWithAuditedBetaReleases` array should be updated to include the new language like this:
|
||||
|
||||
```ts
|
||||
export const languagesWithAuditedBetaReleases: ['english', 'dothraki'];
|
||||
```
|
||||
|
||||
This will move the new superblock to the correct place in the curriculum map on `/learn`.
|
||||
|
||||
## Enabling Localized Videos
|
||||
|
||||
For the video challenges, you need to change a few things. First add the new locale to the GraphQL query in the `client/src/templates/Challenges/video/Show.tsx` file. For example, adding Dothraki to the query:
|
||||
|
||||
```tsx
|
||||
query VideoChallenge($slug: String!) {
|
||||
challengeNode(fields: { slug: { eq: $slug } }) {
|
||||
videoId
|
||||
videoLocaleIds {
|
||||
espanol
|
||||
italian
|
||||
portuguese
|
||||
dothraki
|
||||
}
|
||||
...
|
||||
```
|
||||
|
||||
Then add an id for the new language to any video challenge in an audited block. For example, if `auditedCerts` in `all-langs.ts` includes `scientific-computing-with-python` for `dothraki`, then you must add a `dothraki` entry in `videoLocaleIds`. The frontmatter should then look like this:
|
||||
|
||||
```yml
|
||||
videoLocaleIds:
|
||||
espanol: 3muQV-Im3Z0
|
||||
italian: hiRTRAqNlpE
|
||||
portuguese: AelGAcoMXbI
|
||||
dothraki: new-id-here
|
||||
dashedName: introduction-why-program
|
||||
---
|
||||
```
|
||||
|
||||
Update the `VideoLocaleIds` interface in `client/src/redux/prop-types` to include the new language.
|
||||
|
||||
```ts
|
||||
export interface VideoLocaleIds {
|
||||
espanol?: string;
|
||||
italian?: string;
|
||||
portuguese?: string;
|
||||
dothraki?: string;
|
||||
}
|
||||
```
|
||||
|
||||
And finally update the challenge schema in `curriculum/schema/challengeSchema.js`.
|
||||
|
||||
```js
|
||||
videoLocaleIds: Joi.when('challengeType', {
|
||||
is: challengeTypes.video,
|
||||
then: Joi.object().keys({
|
||||
espanol: Joi.string(),
|
||||
italian: Joi.string(),
|
||||
portuguese: Joi.string(),
|
||||
dothraki: Joi.string()
|
||||
})
|
||||
}),
|
||||
```
|
||||
|
||||
## Client UI
|
||||
|
||||
You will need to take an additional step to handle the client UI translations.
|
||||
|
||||
The Crowdin workflows will automatically pull down _some_ of the UI translations, but there are a couple of files that need to be moved manually.
|
||||
|
||||
You will want to copy the following files from `/client/i18n/locales/english` to `/client/i18n/locales/<your-language>`, and apply translations as needed:
|
||||
|
||||
- `links.json`
|
||||
- `meta-tags.json`
|
||||
- `motivation.json`
|
||||
- `trending.json`
|
||||
|
||||
## Testing Translations Locally
|
||||
|
||||
If you would like to test translations locally, before adding them to our main repository - skip the Crowdin workflow changes. Follow the steps for enabling a language, then download the translations from Crowdin and load them into your local code.
|
||||
|
||||
Because the language has not been approved for production, our scripts are not automatically downloading the translations yet. Only staff have the access to directly download the translations - you are welcome to reach out to us in our [contributors chat room](https://discord.gg/PRyKn3Vbay), or you can translate the English markdown files locally for testing purposes.
|
||||
|
||||
Once you have the files, you will need to place them in the correct directory. For the curriculum challenges, you should place the certification folders (i.e. `01-responsive-web-design`) within the `curriculum/challenges/{lang}` directory. For our Dothraki translations, this would be `curriculum/challenges/dothraki`. The client translation `.json` files will go in the `client/i18n/locales/{lang}` directory.
|
||||
|
||||
Update your `.env` file to use your new language for `CLIENT_LOCALE` and `CURRICULUM_LOCALE`.
|
||||
|
||||
Once these are in place, you should be able to run `npm run develop` to view your translated version of freeCodeCamp.
|
||||
|
||||
> [!ATTENTION] While you may perform translations locally for the purpose of testing, we remind everyone that translations should _not_ be submitted through GitHub and should only be done through Crowdin. Be sure to reset your local codebase after you are done testing.
|
||||
@@ -65,7 +65,7 @@ Este é um exemplo de como deve ser a aparência de parte do arquivo `trending.j
|
||||
}
|
||||
```
|
||||
|
||||
Você vai querer [fazer a build do client traduzido localmente](how-to-test-translations-locally.md) para ver se os títulos têm o comprimento correto. Cada título deve permanecer em uma única linha e não deve ir para uma nova linha.
|
||||
You will want to [build the translated client locally](how-to-enable-new-languages.md) to see if the titles have the right length. Cada título deve permanecer em uma única linha e não deve ir para uma nova linha.
|
||||
|
||||
### Como atualizar os artigos em destaque no cdn
|
||||
|
||||
|
||||
@@ -19,11 +19,10 @@
|
||||
- [Працюйте над документацією](how-to-work-on-the-docs-theme.md)
|
||||
- [Працюйте над компонентною бібліотекою](how-to-work-on-the-component-library.md)
|
||||
- **Додаткові інструкції**
|
||||
- [Тестування перекладів локально](how-to-test-translations-locally.md)
|
||||
- [Ознайомлення зі структурою файлів навчальної програми](curriculum-file-structure.md)
|
||||
- [Налагодження вихідних електронних листів локально](how-to-catch-outgoing-emails-locally.md)
|
||||
- [Встановлення freeCodeCamp на Windows (WSL)](how-to-setup-wsl.md)
|
||||
- [Робочий процес токенів користувача](user-token-workflow.md)
|
||||
- [Understand the curriculum file structure](curriculum-file-structure.md)
|
||||
- [Debug outgoing emails locally](how-to-catch-outgoing-emails-locally.md)
|
||||
- [Set up freeCodeCamp on Windows (WSL)](how-to-setup-wsl.md)
|
||||
- [User Token Workflow](user-token-workflow.md)
|
||||
|
||||
---
|
||||
|
||||
@@ -32,6 +31,7 @@
|
||||
- [Довідник мовного керівника](language-lead-handbook.md)
|
||||
- [Довідник DevOps](devops.md)
|
||||
- [Розширення курсів VSCode](courses-vscode-extension.md)
|
||||
- [Enable New Language](how-to-enable-new-languages.md)
|
||||
|
||||
---
|
||||
|
||||
|
||||
279
docs/i18n/ukrainian/how-to-enable-new-languages.md
Normal file
279
docs/i18n/ukrainian/how-to-enable-new-languages.md
Normal file
@@ -0,0 +1,279 @@
|
||||
# Deploying New Languages on `/learn`
|
||||
|
||||
Before you can release a new language, you will need to allow the languages to download from Crowdin.
|
||||
|
||||
## Updating Crowdin Settings
|
||||
|
||||
In the `Curriculum` and `Learn UI` projects, you will need to select `Project Settings` from the sidebar. Then scroll down to `Language Mapping`, where you will see an option to add custom language codes. Add a new entry for the language you are releasing, selecting `language` as the `Placeholder` value, and entering a URL-friendly lower-case spelling of your language's name for the `Custom code`. If you aren't sure what to use, reach out in our contributor chat and we will assist you.
|
||||
|
||||
## Updating Workflows
|
||||
|
||||
You will need to add a step to the `crowdin-download.client-ui.yml` and `crowdin-download.curriculum.yml`. The step for these will be the same. For example, if you want to enable Dothraki downloads:
|
||||
|
||||
```yml
|
||||
##### Download Dothraki #####
|
||||
- name: Crowdin Download Dothraki Translations
|
||||
uses: crowdin/github-action@master
|
||||
# options: https://github.com/crowdin/github-action/blob/master/action.yml
|
||||
with:
|
||||
# uploads
|
||||
upload_sources: false
|
||||
upload_translations: false
|
||||
auto_approve_imported: false
|
||||
import_eq_suggestions: false
|
||||
|
||||
# downloads
|
||||
download_translations: true
|
||||
download_language: mis
|
||||
skip_untranslated_files: false
|
||||
export_only_approved: true
|
||||
|
||||
push_translations: false
|
||||
|
||||
# pull-request
|
||||
create_pull_request: false
|
||||
|
||||
# global options
|
||||
config: './crowdin-config.yml'
|
||||
base_url: ${{ secrets.CROWDIN_BASE_URL_FCC }}
|
||||
|
||||
# Uncomment below to debug
|
||||
# dryrun_action: true
|
||||
```
|
||||
|
||||
Note that the `download_language` key needs to be set to the language code displayed on Crowdin.
|
||||
|
||||
## Enabling a Language
|
||||
|
||||
> [!NOTE] The above section with updating the workflows should be completed before proceeding - these need to be done in separate steps or the builds will fail.
|
||||
|
||||
There are a few steps to take in order to allow the codebase to build in your desired language.
|
||||
|
||||
First, visit the `config/i18n/all-langs.ts` file to add the language to the available languages list and configure the values. There are several objects here.
|
||||
|
||||
- `availableLangs`: For both the `client` and `curriculum` arrays, add the text name of the language. This is the value that will be used in the `.env` file later.
|
||||
- `auditedCerts`: Add the text name of the language as the _key_, and add an array of `SuperBlocks.{cert}` variables as the _value_. This tells the client which certifications are fully translated.
|
||||
- `i18nextCodes`: These are the ISO language codes for each language. You will need to add the appropriate ISO code for the language you are enabling. These do need to be unique for each language.
|
||||
- `LangNames`: These are the display names for the language selector in the navigation menu.
|
||||
- `LangCodes`: These are the language codes used for formatting dates and numbers. These should be Unicode CLDR codes instead of ISO codes.
|
||||
- `hiddenLangs`: These languages will not be displayed in the navigation menu. This is used for languages that are not yet ready for release.
|
||||
|
||||
As an example, if you wanted to enable Dothraki as a language, your `all-langs.js` objects should look like this:
|
||||
|
||||
```js
|
||||
export const availableLangs = {
|
||||
client: ['english', 'espanol', 'chinese', 'chinese-traditional', 'dothraki'],
|
||||
curriculum: [
|
||||
'english',
|
||||
'espanol',
|
||||
'chinese',
|
||||
'chinese-traditional',
|
||||
'dothraki'
|
||||
]
|
||||
};
|
||||
|
||||
export const auditedCerts = {
|
||||
espanol: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis
|
||||
],
|
||||
chinese: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis,
|
||||
SuperBlocks.QualityAssurance,
|
||||
SuperBlocks.SciCompPy,
|
||||
SuperBlocks.DataAnalysisPy,
|
||||
SuperBlocks.InfoSec,
|
||||
SuperBlocks.MachineLearningPy
|
||||
],
|
||||
'chinese-traditional': [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs,
|
||||
SuperBlocks.DataVis,
|
||||
SuperBlocks.BackEndDevApis,
|
||||
SuperBlocks.QualityAssurance,
|
||||
SuperBlocks.SciCompPy,
|
||||
SuperBlocks.DataAnalysisPy,
|
||||
SuperBlocks.InfoSec,
|
||||
SuperBlocks.MachineLearningPy
|
||||
],
|
||||
dothraki: [
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs
|
||||
]
|
||||
};
|
||||
|
||||
export const i18nextCodes = {
|
||||
english: 'en',
|
||||
espanol: 'es',
|
||||
chinese: 'zh',
|
||||
'chinese-traditional': 'zh-Hant',
|
||||
dothraki: 'mis'
|
||||
};
|
||||
|
||||
export enum LangNames = {
|
||||
english: 'English',
|
||||
espanol: 'Español',
|
||||
chinese: '中文（简体字）',
|
||||
'chinese-traditional': '中文（繁體字）',
|
||||
dothraki: 'Dothraki'
|
||||
};
|
||||
|
||||
export enum LangCodes = {
|
||||
english: 'en-US',
|
||||
espanol: 'es-419',
|
||||
chinese: 'zh',
|
||||
'chinese-traditional': 'zh-Hant',
|
||||
dothraki: 'mis'
|
||||
};
|
||||
|
||||
export const hiddenLangs = ['dothraki'];
|
||||
```
|
||||
|
||||
> [!NOTE] When a language has been set up in the deployment pipeline AND has a public `/news` instance live, it can be removed from the `hiddenLangs` array and be made available to the public.
|
||||
|
||||
Next, open the `client/src/utils/algolia-locale-setup.ts` file. This data is used for the search bar that loads `/news` articles. While it is unlikely that you are going to test this functionality, missing the data for your language can lead to errors when attempting to build the codebase locally.
|
||||
|
||||
Add an object for your language to the `algoliaIndices` object. You should use the the same values as the `english` object for local testing, replacing the `english` key with your language's `availableLangs` value.
|
||||
|
||||
> [!NOTE] If we have already deployed an instance of news in your target language, you can update the values to reflect the live instance. Otherwise, use the English values.
|
||||
|
||||
If you were to add Dothraki:
|
||||
|
||||
```js
|
||||
const algoliaIndices = {
|
||||
english: {
|
||||
name: 'news',
|
||||
searchPage: 'https://www.freecodecamp.org/news/search/'
|
||||
},
|
||||
espanol: {
|
||||
name: 'news-es',
|
||||
searchPage: 'https://www.freecodecamp.org/espanol/news/search/'
|
||||
},
|
||||
chinese: {
|
||||
name: 'news-zh',
|
||||
searchPage: 'https://chinese.freecodecamp.org/news/search/'
|
||||
},
|
||||
'chinese-traditional': {
|
||||
name: 'news-zh',
|
||||
searchPage: 'https://chinese.freecodecamp.org/news/search'
|
||||
},
|
||||
dothraki: {
|
||||
name: 'news',
|
||||
searchPage: 'https://www.freecodecamp.org/news/search/'
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
### Releasing a Superblock
|
||||
|
||||
After a superblock has been fully translated into a language, there are two steps to release it. First add the superblock enum to that language's `auditedCerts` array. So, if you want to release the new Responsive Web Design superblock for Dothraki, the array should look like this:
|
||||
|
||||
```ts
|
||||
export const auditedCerts = {
|
||||
// other languages
|
||||
dothraki: [
|
||||
SuperBlocks.RespWebDesignNew, // the newly translated superblock
|
||||
SuperBlocks.RespWebDesign,
|
||||
SuperBlocks.JsAlgoDataStruct,
|
||||
SuperBlocks.FrontEndDevLibs
|
||||
]
|
||||
};
|
||||
```
|
||||
|
||||
Finally, if the superblock is in a "new" state (that is, replacing a legacy superblock), the `languagesWithAuditedBetaReleases` array should be updated to include the new language like this:
|
||||
|
||||
```ts
|
||||
export const languagesWithAuditedBetaReleases: ['english', 'dothraki'];
|
||||
```
|
||||
|
||||
This will move the new superblock to the correct place in the curriculum map on `/learn`.
|
||||
|
||||
## Enabling Localized Videos
|
||||
|
||||
For the video challenges, you need to change a few things. First add the new locale to the GraphQL query in the `client/src/templates/Challenges/video/Show.tsx` file. For example, adding Dothraki to the query:
|
||||
|
||||
```tsx
|
||||
query VideoChallenge($slug: String!) {
|
||||
challengeNode(fields: { slug: { eq: $slug } }) {
|
||||
videoId
|
||||
videoLocaleIds {
|
||||
espanol
|
||||
italian
|
||||
portuguese
|
||||
dothraki
|
||||
}
|
||||
...
|
||||
```
|
||||
|
||||
Then add an id for the new language to any video challenge in an audited block. For example, if `auditedCerts` in `all-langs.ts` includes `scientific-computing-with-python` for `dothraki`, then you must add a `dothraki` entry in `videoLocaleIds`. The frontmatter should then look like this:
|
||||
|
||||
```yml
|
||||
videoLocaleIds:
|
||||
espanol: 3muQV-Im3Z0
|
||||
italian: hiRTRAqNlpE
|
||||
portuguese: AelGAcoMXbI
|
||||
dothraki: new-id-here
|
||||
dashedName: introduction-why-program
|
||||
---
|
||||
```
|
||||
|
||||
Update the `VideoLocaleIds` interface in `client/src/redux/prop-types` to include the new language.
|
||||
|
||||
```ts
|
||||
export interface VideoLocaleIds {
|
||||
espanol?: string;
|
||||
italian?: string;
|
||||
portuguese?: string;
|
||||
dothraki?: string;
|
||||
}
|
||||
```
|
||||
|
||||
And finally update the challenge schema in `curriculum/schema/challengeSchema.js`.
|
||||
|
||||
```js
|
||||
videoLocaleIds: Joi.when('challengeType', {
|
||||
is: challengeTypes.video,
|
||||
then: Joi.object().keys({
|
||||
espanol: Joi.string(),
|
||||
italian: Joi.string(),
|
||||
portuguese: Joi.string(),
|
||||
dothraki: Joi.string()
|
||||
})
|
||||
}),
|
||||
```
|
||||
|
||||
## Client UI
|
||||
|
||||
You will need to take an additional step to handle the client UI translations.
|
||||
|
||||
The Crowdin workflows will automatically pull down _some_ of the UI translations, but there are a couple of files that need to be moved manually.
|
||||
|
||||
You will want to copy the following files from `/client/i18n/locales/english` to `/client/i18n/locales/<your-language>`, and apply translations as needed:
|
||||
|
||||
- `links.json`
|
||||
- `meta-tags.json`
|
||||
- `motivation.json`
|
||||
- `trending.json`
|
||||
|
||||
## Testing Translations Locally
|
||||
|
||||
If you would like to test translations locally, before adding them to our main repository - skip the Crowdin workflow changes. Follow the steps for enabling a language, then download the translations from Crowdin and load them into your local code.
|
||||
|
||||
Because the language has not been approved for production, our scripts are not automatically downloading the translations yet. Only staff have the access to directly download the translations - you are welcome to reach out to us in our [contributors chat room](https://discord.gg/PRyKn3Vbay), or you can translate the English markdown files locally for testing purposes.
|
||||
|
||||
Once you have the files, you will need to place them in the correct directory. For the curriculum challenges, you should place the certification folders (i.e. `01-responsive-web-design`) within the `curriculum/challenges/{lang}` directory. For our Dothraki translations, this would be `curriculum/challenges/dothraki`. The client translation `.json` files will go in the `client/i18n/locales/{lang}` directory.
|
||||
|
||||
Update your `.env` file to use your new language for `CLIENT_LOCALE` and `CURRICULUM_LOCALE`.
|
||||
|
||||
Once these are in place, you should be able to run `npm run develop` to view your translated version of freeCodeCamp.
|
||||
|
||||
> [!ATTENTION] While you may perform translations locally for the purpose of testing, we remind everyone that translations should _not_ be submitted through GitHub and should only be done through Crowdin. Be sure to reset your local codebase after you are done testing.
|
||||
@@ -65,7 +65,7 @@ This is an example of how part of the `trending.json` file has to look.
|
||||
}
|
||||
```
|
||||
|
||||
You will want to [build the translated client locally](how-to-test-translations-locally.md) to see if the titles have the right length. Each title must stay on a single line and not go to a new line.
|
||||
You will want to [build the translated client locally](how-to-enable-new-languages.md) to see if the titles have the right length. Each title must stay on a single line and not go to a new line.
|
||||
|
||||
### How to update the trending articles in the cdn
|
||||
|
||||
|
||||
Reference in New Issue
Block a user