chore(i18n,docs): update translations (#43031)
This commit is contained in:
camperbot
GitHub
@ -19,6 +19,7 @@
|
||||
- [在本地运行客户端 web app](how-to-work-on-localized-client-webapp.md)
|
||||
- [本地接收电子邮件](how-to-catch-outgoing-emails-locally.md)
|
||||
- [测试本地翻译](how-to-test-translations-locally.md)
|
||||
- [Understand the curriculum file structure](curriculum-file-structure.md)
|
||||
|
||||
---
|
||||
|
||||
|
||||
104
docs/i18n/chinese/curriculum-file-structure.md
Normal file
104
docs/i18n/chinese/curriculum-file-structure.md
Normal file
@ -0,0 +1,104 @@
|
||||
# Curriculum File Structure
|
||||
|
||||
Our core instructional content is located within the conveniently named `curriculum` directory. This page will break down how these files are organized.
|
||||
|
||||
## Terminology
|
||||
|
||||
There are a few terms we use when discussing our curriculum content.
|
||||
|
||||
- `certification` : When referring to a certification in this instance, it is talking about the actual certificate that users claim. Which is separate from the name of the superBlock.
|
||||
- `superBlock` : A superblock is the top level collection of challenges. Each superblock corresponds to a certification in the curriculum (i.e. Responsive Web Design).
|
||||
- `block` : A block is a section within a superblock. A block corresponds to a group of challenges in a given certification (i.e. Basic HTML and HTML5)
|
||||
- `challenge` : A challenge is a single lesson within the curriculum (i.e. Say Hello to HTML Elements)
|
||||
|
||||
## File Tree
|
||||
|
||||
Using those terms, here is how the file structure would be defined:
|
||||
|
||||
```md
|
||||
|
||||
curriculum/
|
||||
├─ _meta/
|
||||
│ ├─ {block}/
|
||||
│ │ ├─ meta.json
|
||||
├─ {language}/
|
||||
│ ├─ {superBlock}/
|
||||
│ │ ├─ {block}/
|
||||
│ │ │ ├─ {challenge}.md
|
||||
```
|
||||
|
||||
## The `_meta` Directory
|
||||
|
||||
The `_meta` directory is a special directory which contains `.json` files. These files correspond to each block in the curriculum, and are used to determine which superBlock a block belongs to, and the order of the challenges within that block.
|
||||
|
||||
## Renaming Files
|
||||
|
||||
There may be times when you need to rename a certificate, superblock, block, or challenge. This section will outline the steps needed to avoid build errors when doing so.
|
||||
|
||||
> [!ATTENTION] Renaming files within the curriculum structure will often change the path (or URL) of the content on the main webpage. Doing so should be done with care, as redirects have to be set up for each change that is made.
|
||||
|
||||
### Renaming a Certification
|
||||
|
||||
When renaming a certification, you will likely want to rename the associated superblock along with it. Do the following to rename only the certificate:
|
||||
|
||||
1. Rename the `curriculum/challenges/_meta/{superBlock}-certficate` folder to the new name.
|
||||
1. In the `meta.json` file of that folder, rename the values in `name`, `dashedName`, and `challengeOrder` to the new cert name.
|
||||
1. In `curriculum/challenges/english/12-certificate`, rename the `{superBlock}-certificate` folder, and the YAML file within it, to the new name.
|
||||
1. In the YAML file, change the `title` to the new name.
|
||||
1. Rename the file and folder from step 3 for the rest curriculum languages.
|
||||
1. Update `client/src/redux/index.ts` to use the correct `title`.
|
||||
1. Optionally, update the `certSlug` for the superblock in the same file. **Note** that renaming a `certSlug` will change the URL for certifications and should only be done with careful consideration.
|
||||
1. Update the `title` in `client/src/resources/cert-and-project-map.ts` to the new value. **Note** that changing the `title` here **will break** the superBlock page for the associated certification. It relies on the superBlock title to match the certification title. You will likely want to rename the superBlock at the same time.
|
||||
1. If you renamed the `certSlug` in step 7, change it here for the cert and all the nested `projects` values.
|
||||
1. In `config/certification-settings.js`, update the value of `certTypeTitleMap` to the new name.
|
||||
1. If you renamed the `certSlug` in step 7, update the key of `certSlugTypeMap` in the same file.
|
||||
1. Update the certificate name in the `legacyCerts` array of the `client/src/client-only-routes/show-project-links.tsx` if needed.
|
||||
1. Update the main `README.md` file to the new name.
|
||||
|
||||
### Renaming a Superblock
|
||||
|
||||
> [!NOTE] When you rename a superBlock, the new folder name is used as the path and should be considered the "correct" name. All other values should be updated to reflect that change.
|
||||
|
||||
Also, you will likely want to rename the certificate and the `{superBlock}-projects` block when you rename a superBlock since they all shares a name. To rename only a superBlock you need to:
|
||||
|
||||
1. Rename the superBlock folder in the `curriculum/challenges/english` directory.
|
||||
1. Rename the superBlock folder in *all* other `curriculum/challenges/{language}` directories.
|
||||
1. For each block within that superBlock, update the `superBlock` value in the `meta.json` file to its dashedName. You don't need to rename any folders here. Do that when renaming a block.
|
||||
1. Rename the superblock folder in `client/src/pages/learn`.
|
||||
1. Update the `index.md` file in the above folder, changing the `title` and `superBlock` values to the new name.
|
||||
1. For each block folder within the above, update the `index.md` to use the correct `superBlock` value.
|
||||
1. In the `client/src/resources/cert-and-project-map.ts` file, update the path for the cert at the top of the file, and the `title` value for that superBlock. **Note** that changing the `title` here **will break** the ability to view the actual certification for this superBlock. It relies on the superBlock title to match the certification title. You will likely want to rename the certification at the same time.
|
||||
1. Update the `superBlockCertTypeMap` key in `config/certification-settings.js` to the new superBlock name.
|
||||
1. Update the path value in `client/src/assets/icons/index.tsx`.
|
||||
1. For each language in `client/i18n/locales`, update the `intro.json` file to use the new superBlock `dashedName`. In the English file, also update the `title`.
|
||||
1. Check the `config/i18n/all-langs.js` file to see if the superBlock is enabled in i18n builds. Update all the values where it is used.
|
||||
1. Update the main `README.md` file to the new name.
|
||||
|
||||
### Renaming a Block
|
||||
|
||||
When renaming a curriculum block, you need to:
|
||||
|
||||
1. Change the name of the block folder in the `curriculum/challenges/english/{superBlock}` directory.
|
||||
1. Change the name of the same block folder in *all* of the other language directories to match. These must all be the same as the English structure or the build will error out.
|
||||
1. Change the name of the block folder in the `_meta` directory.
|
||||
1. Update the `name` and `dashedName` property for that block's `meta.json` file.
|
||||
1. Update the `client/utils/help-category-map.json` to use the new block name as the key.
|
||||
1. Update the block folder in `client/src/pages/learn/{superBlock}`.
|
||||
1. In the `index.md` file of the above folder, update the `block` value in the frontmatter.
|
||||
1. In the `client/i18n/locales/{language}/intro.json` files, update the block name to the new name for all the languages. In the English `intro.json` file, update the `title` as well.
|
||||
1. Update the main `README.md` file to the new name.
|
||||
|
||||
### Renaming a Challenge
|
||||
|
||||
When renaming a single challenge file, you need to:
|
||||
|
||||
1. Change the name of the challenge file in the `curriculum/challenges/english` directory.
|
||||
1. Change the name of the `title` and `dashedName` within that file.
|
||||
1. Change the of the file, and the `dashedName` in those files for *all* of the other language directories to match.
|
||||
1. Update the name of the challenge in the relevant `meta.json` file. The challenge names here are not used in the build, but provide a user-friendly way to identify the challenge order.
|
||||
1. If the challenge is a certificate project, update the YAML file in `curriculum/english/12-certificates/<superBlock>` to the new name.
|
||||
1. If the challenge is a certificate project, update the main `README.md` file to the new name.
|
||||
|
||||
## The `dashedName` Property
|
||||
|
||||
The `dashedName` property is used to generate the URL path for the superblock, block, or challenge. These should generally match what the `/utils/dasherize.js` helper would output for the file name.
|
||||
@ -203,7 +203,7 @@ You can identify the exact version deployed by visiting the build and deployment
|
||||
|
||||
There are some known limitations and tradeoffs when using the beta version of the platform.
|
||||
|
||||
- #### All data / personal progress on these beta platforms `will NOT be saved or carried over` to production.
|
||||
- #### All data / personal progress on these beta platforms will NOT be saved or carried over to production.
|
||||
|
||||
**Users on the beta version will have a separate account from the production.** The beta version uses a physically separate database from production. This gives us the ability to prevent any accidental loss of data or modifications. The dev team may purge the database on this beta version as needed.
|
||||
|
||||
|
||||
@ -85,7 +85,7 @@ part-6.md
|
||||
|
||||
At some point you decide you need to delete `part-2.md`, because that step is no longer needed. Also, you decide to break down `part-4.md` into three steps instead of just one.
|
||||
|
||||
To accomplish this restructure, you would need to delete `part-2.md` and then add a `part-4a.md` and a `part-5b.md`. The new folder structure would look like the following:
|
||||
To accomplish this restructure, you would need to delete `part-2.md` and then add a `part-4a.md` and a `part-4b.md`. The new folder structure would look like the following:
|
||||
|
||||
```bash
|
||||
part-001.md
|
||||
|
||||
@ -111,7 +111,7 @@ Sometimes there will be a Merge Conflict.
|
||||
|
||||
This means that another pull request has made a change to that same part of that same file. GitHub has a tool for addressing these merge conflicts right on GitHub. You can try to address these conflicts. Just use your best judgment.
|
||||
|
||||
The pull request's changes will be on top, and the Master branch's changes will be on the bottom. Sometimes there will be redundant information in there that can be deleted. Before you finish, be sure to delete the `<<<<<<`, `======`, and `>>>>>>` that Git adds to indicate areas of conflict.
|
||||
The pull request's changes will be on top, and the main branch's changes will be on the bottom. Sometimes there will be redundant information in there that can be deleted. Before you finish, be sure to delete the `<<<<<<`, `======`, and `>>>>>>` that Git adds to indicate areas of conflict.
|
||||
|
||||
If you are uncertain, please ask one of the fellow moderators or the dev-team for assistance.
|
||||
|
||||
@ -408,7 +408,7 @@ git remote add upstream git://github.com/freeCodeCamp/freeCodeCamp.git
|
||||
|
||||
git fetch upstream
|
||||
|
||||
git pull upstream master
|
||||
git pull upstream main
|
||||
````
|
||||
|
||||
If you're using a GUI, you can simply `Add a new remote...` and use the link `git://github.com/freeCodeCamp/freeCodeCamp.git` from above.
|
||||
|
||||
@ -19,6 +19,7 @@
|
||||
- [Work on localized client web app](how-to-work-on-localized-client-webapp.md)
|
||||
- [Catch outgoing emails locally](how-to-catch-outgoing-emails-locally.md)
|
||||
- [Test translations locally](how-to-test-translations-locally.md)
|
||||
- [Understand the curriculum file structure](curriculum-file-structure.md)
|
||||
|
||||
---
|
||||
|
||||
|
||||
104
docs/i18n/espanol/curriculum-file-structure.md
Normal file
104
docs/i18n/espanol/curriculum-file-structure.md
Normal file
@ -0,0 +1,104 @@
|
||||
# Curriculum File Structure
|
||||
|
||||
Our core instructional content is located within the conveniently named `curriculum` directory. This page will break down how these files are organized.
|
||||
|
||||
## Terminology
|
||||
|
||||
There are a few terms we use when discussing our curriculum content.
|
||||
|
||||
- `certification` : When referring to a certification in this instance, it is talking about the actual certificate that users claim. Which is separate from the name of the superBlock.
|
||||
- `superBlock` : A superblock is the top level collection of challenges. Each superblock corresponds to a certification in the curriculum (i.e. Responsive Web Design).
|
||||
- `block` : A block is a section within a superblock. A block corresponds to a group of challenges in a given certification (i.e. Basic HTML and HTML5)
|
||||
- `challenge` : A challenge is a single lesson within the curriculum (i.e. Say Hello to HTML Elements)
|
||||
|
||||
## File Tree
|
||||
|
||||
Using those terms, here is how the file structure would be defined:
|
||||
|
||||
```md
|
||||
|
||||
curriculum/
|
||||
├─ _meta/
|
||||
│ ├─ {block}/
|
||||
│ │ ├─ meta.json
|
||||
├─ {language}/
|
||||
│ ├─ {superBlock}/
|
||||
│ │ ├─ {block}/
|
||||
│ │ │ ├─ {challenge}.md
|
||||
```
|
||||
|
||||
## The `_meta` Directory
|
||||
|
||||
The `_meta` directory is a special directory which contains `.json` files. These files correspond to each block in the curriculum, and are used to determine which superBlock a block belongs to, and the order of the challenges within that block.
|
||||
|
||||
## Renaming Files
|
||||
|
||||
There may be times when you need to rename a certificate, superblock, block, or challenge. This section will outline the steps needed to avoid build errors when doing so.
|
||||
|
||||
> [!ATTENTION] Renaming files within the curriculum structure will often change the path (or URL) of the content on the main webpage. Doing so should be done with care, as redirects have to be set up for each change that is made.
|
||||
|
||||
### Renaming a Certification
|
||||
|
||||
When renaming a certification, you will likely want to rename the associated superblock along with it. Do the following to rename only the certificate:
|
||||
|
||||
1. Rename the `curriculum/challenges/_meta/{superBlock}-certficate` folder to the new name.
|
||||
1. In the `meta.json` file of that folder, rename the values in `name`, `dashedName`, and `challengeOrder` to the new cert name.
|
||||
1. In `curriculum/challenges/english/12-certificate`, rename the `{superBlock}-certificate` folder, and the YAML file within it, to the new name.
|
||||
1. In the YAML file, change the `title` to the new name.
|
||||
1. Rename the file and folder from step 3 for the rest curriculum languages.
|
||||
1. Update `client/src/redux/index.ts` to use the correct `title`.
|
||||
1. Optionally, update the `certSlug` for the superblock in the same file. **Note** that renaming a `certSlug` will change the URL for certifications and should only be done with careful consideration.
|
||||
1. Update the `title` in `client/src/resources/cert-and-project-map.ts` to the new value. **Note** that changing the `title` here **will break** the superBlock page for the associated certification. It relies on the superBlock title to match the certification title. You will likely want to rename the superBlock at the same time.
|
||||
1. If you renamed the `certSlug` in step 7, change it here for the cert and all the nested `projects` values.
|
||||
1. In `config/certification-settings.js`, update the value of `certTypeTitleMap` to the new name.
|
||||
1. If you renamed the `certSlug` in step 7, update the key of `certSlugTypeMap` in the same file.
|
||||
1. Update the certificate name in the `legacyCerts` array of the `client/src/client-only-routes/show-project-links.tsx` if needed.
|
||||
1. Update the main `README.md` file to the new name.
|
||||
|
||||
### Renaming a Superblock
|
||||
|
||||
> [!NOTE] When you rename a superBlock, the new folder name is used as the path and should be considered the "correct" name. All other values should be updated to reflect that change.
|
||||
|
||||
Also, you will likely want to rename the certificate and the `{superBlock}-projects` block when you rename a superBlock since they all shares a name. To rename only a superBlock you need to:
|
||||
|
||||
1. Rename the superBlock folder in the `curriculum/challenges/english` directory.
|
||||
1. Rename the superBlock folder in *all* other `curriculum/challenges/{language}` directories.
|
||||
1. For each block within that superBlock, update the `superBlock` value in the `meta.json` file to its dashedName. You don't need to rename any folders here. Do that when renaming a block.
|
||||
1. Rename the superblock folder in `client/src/pages/learn`.
|
||||
1. Update the `index.md` file in the above folder, changing the `title` and `superBlock` values to the new name.
|
||||
1. For each block folder within the above, update the `index.md` to use the correct `superBlock` value.
|
||||
1. In the `client/src/resources/cert-and-project-map.ts` file, update the path for the cert at the top of the file, and the `title` value for that superBlock. **Note** that changing the `title` here **will break** the ability to view the actual certification for this superBlock. It relies on the superBlock title to match the certification title. You will likely want to rename the certification at the same time.
|
||||
1. Update the `superBlockCertTypeMap` key in `config/certification-settings.js` to the new superBlock name.
|
||||
1. Update the path value in `client/src/assets/icons/index.tsx`.
|
||||
1. For each language in `client/i18n/locales`, update the `intro.json` file to use the new superBlock `dashedName`. In the English file, also update the `title`.
|
||||
1. Check the `config/i18n/all-langs.js` file to see if the superBlock is enabled in i18n builds. Update all the values where it is used.
|
||||
1. Update the main `README.md` file to the new name.
|
||||
|
||||
### Renaming a Block
|
||||
|
||||
When renaming a curriculum block, you need to:
|
||||
|
||||
1. Change the name of the block folder in the `curriculum/challenges/english/{superBlock}` directory.
|
||||
1. Change the name of the same block folder in *all* of the other language directories to match. These must all be the same as the English structure or the build will error out.
|
||||
1. Change the name of the block folder in the `_meta` directory.
|
||||
1. Update the `name` and `dashedName` property for that block's `meta.json` file.
|
||||
1. Update the `client/utils/help-category-map.json` to use the new block name as the key.
|
||||
1. Update the block folder in `client/src/pages/learn/{superBlock}`.
|
||||
1. In the `index.md` file of the above folder, update the `block` value in the frontmatter.
|
||||
1. In the `client/i18n/locales/{language}/intro.json` files, update the block name to the new name for all the languages. In the English `intro.json` file, update the `title` as well.
|
||||
1. Update the main `README.md` file to the new name.
|
||||
|
||||
### Renaming a Challenge
|
||||
|
||||
When renaming a single challenge file, you need to:
|
||||
|
||||
1. Change the name of the challenge file in the `curriculum/challenges/english` directory.
|
||||
1. Change the name of the `title` and `dashedName` within that file.
|
||||
1. Change the of the file, and the `dashedName` in those files for *all* of the other language directories to match.
|
||||
1. Update the name of the challenge in the relevant `meta.json` file. The challenge names here are not used in the build, but provide a user-friendly way to identify the challenge order.
|
||||
1. If the challenge is a certificate project, update the YAML file in `curriculum/english/12-certificates/<superBlock>` to the new name.
|
||||
1. If the challenge is a certificate project, update the main `README.md` file to the new name.
|
||||
|
||||
## The `dashedName` Property
|
||||
|
||||
The `dashedName` property is used to generate the URL path for the superblock, block, or challenge. These should generally match what the `/utils/dasherize.js` helper would output for the file name.
|
||||
@ -26,11 +26,11 @@ Una vez que el equipo de desarrolladores [`@freeCodeCamp/dev-team`](https://gith
|
||||
|
||||
Esta es la versión final que despliega los cambios a nuestras plataformas de producción en freeCodeCamp.org.
|
||||
|
||||
#### Pruebas de cambios - Pruebas de Integración y Aceptación del Usuario.
|
||||
#### Pruebas de cambios - pruebas de Integración y aceptación del usuario.
|
||||
|
||||
Empleamos varios niveles de pruebas de integración y aceptación para verificar la calidad del código. Todas nuestras pruebas se realizan a través de software como [GitHub Actions CI](https://github.com/freeCodeCamp/freeCodeCamp/actions) y [Azure Pipelines](https://dev.azure.com/freeCodeCamp-org/freeCodeCamp).
|
||||
|
||||
Contamos con pruebas unitarias para probar nuestras soluciones a los desafíos, las API del Servidor y las interfaces de Usuario. Estas nos ayudan a probar la integración entre diferentes componentes.
|
||||
Contamos con pruebas unitarias para probar nuestras soluciones a los desafíos, las API del servidor y las interfaces de usuario. Estas nos ayudan a probar la integración entre diferentes componentes.
|
||||
|
||||
> [!NOTE] También estamos en el proceso de redactar pruebas de usuario final que nos ayudarán a replicar escenarios del mundo real, como actualizar un correo electrónico o hacer una llamada a la API o servicios de terceros.
|
||||
|
||||
@ -203,7 +203,7 @@ Puedes identificar la versión exacta desplegada visitando los registros de comp
|
||||
|
||||
Existen algunas limitaciones y problemas conocidos al utilizar la versión beta de la plataforma.
|
||||
|
||||
- #### Todos los datos / progreso personal en estas plataformas beta `NO se guardarán ni se transferirán` a producción.
|
||||
- #### All data / personal progress on these beta platforms will NOT be saved or carried over to production.
|
||||
|
||||
**Los usuarios de la versión beta tendrán una cuenta separada a la de producción.** La versión beta usa una base de datos físicamente separada de la de producción. Esto nos da la capacidad de prevenir cualquier pérdida accidental de datos o modificaciones. El equipo de desarrollo puede purgar la base de datos en esta versión beta según sea necesario.
|
||||
|
||||
|
||||
@ -85,7 +85,7 @@ part-6.md
|
||||
|
||||
At some point you decide you need to delete `part-2.md`, because that step is no longer needed. Also, you decide to break down `part-4.md` into three steps instead of just one.
|
||||
|
||||
To accomplish this restructure, you would need to delete `part-2.md` and then add a `part-4a.md` and a `part-5b.md`. The new folder structure would look like the following:
|
||||
To accomplish this restructure, you would need to delete `part-2.md` and then add a `part-4a.md` and a `part-4b.md`. The new folder structure would look like the following:
|
||||
|
||||
```bash
|
||||
part-001.md
|
||||
|
||||
@ -111,7 +111,7 @@ Sometimes there will be a Merge Conflict.
|
||||
|
||||
This means that another pull request has made a change to that same part of that same file. GitHub has a tool for addressing these merge conflicts right on GitHub. You can try to address these conflicts. Just use your best judgment.
|
||||
|
||||
The pull request's changes will be on top, and the Master branch's changes will be on the bottom. Sometimes there will be redundant information in there that can be deleted. Before you finish, be sure to delete the `<<<<<<`, `======`, and `>>>>>>` that Git adds to indicate areas of conflict.
|
||||
The pull request's changes will be on top, and the main branch's changes will be on the bottom. Sometimes there will be redundant information in there that can be deleted. Before you finish, be sure to delete the `<<<<<<`, `======`, and `>>>>>>` that Git adds to indicate areas of conflict.
|
||||
|
||||
If you are uncertain, please ask one of the fellow moderators or the dev-team for assistance.
|
||||
|
||||
@ -408,7 +408,7 @@ git remote add upstream git://github.com/freeCodeCamp/freeCodeCamp.git
|
||||
|
||||
git fetch upstream
|
||||
|
||||
git pull upstream master
|
||||
git pull upstream main
|
||||
````
|
||||
|
||||
If you're using a GUI, you can simply `Add a new remote...` and use the link `git://github.com/freeCodeCamp/freeCodeCamp.git` from above.
|
||||
|
||||
@ -19,6 +19,7 @@
|
||||
- [Lavorare sulla app web in locale](how-to-work-on-localized-client-webapp.md)
|
||||
- [Intercettare email in uscita localmente](how-to-catch-outgoing-emails-locally.md)
|
||||
- [Testare traduzioni in locale](how-to-test-translations-locally.md)
|
||||
- [Understand the curriculum file structure](curriculum-file-structure.md)
|
||||
|
||||
---
|
||||
|
||||
|
||||
104
docs/i18n/italian/curriculum-file-structure.md
Normal file
104
docs/i18n/italian/curriculum-file-structure.md
Normal file
@ -0,0 +1,104 @@
|
||||
# Curriculum File Structure
|
||||
|
||||
Our core instructional content is located within the conveniently named `curriculum` directory. This page will break down how these files are organized.
|
||||
|
||||
## Terminology
|
||||
|
||||
There are a few terms we use when discussing our curriculum content.
|
||||
|
||||
- `certification` : When referring to a certification in this instance, it is talking about the actual certificate that users claim. Which is separate from the name of the superBlock.
|
||||
- `superBlock` : A superblock is the top level collection of challenges. Each superblock corresponds to a certification in the curriculum (i.e. Responsive Web Design).
|
||||
- `block` : A block is a section within a superblock. A block corresponds to a group of challenges in a given certification (i.e. Basic HTML and HTML5)
|
||||
- `challenge` : A challenge is a single lesson within the curriculum (i.e. Say Hello to HTML Elements)
|
||||
|
||||
## File Tree
|
||||
|
||||
Using those terms, here is how the file structure would be defined:
|
||||
|
||||
```md
|
||||
|
||||
curriculum/
|
||||
├─ _meta/
|
||||
│ ├─ {block}/
|
||||
│ │ ├─ meta.json
|
||||
├─ {language}/
|
||||
│ ├─ {superBlock}/
|
||||
│ │ ├─ {block}/
|
||||
│ │ │ ├─ {challenge}.md
|
||||
```
|
||||
|
||||
## The `_meta` Directory
|
||||
|
||||
The `_meta` directory is a special directory which contains `.json` files. These files correspond to each block in the curriculum, and are used to determine which superBlock a block belongs to, and the order of the challenges within that block.
|
||||
|
||||
## Renaming Files
|
||||
|
||||
There may be times when you need to rename a certificate, superblock, block, or challenge. This section will outline the steps needed to avoid build errors when doing so.
|
||||
|
||||
> [!ATTENTION] Renaming files within the curriculum structure will often change the path (or URL) of the content on the main webpage. Doing so should be done with care, as redirects have to be set up for each change that is made.
|
||||
|
||||
### Renaming a Certification
|
||||
|
||||
When renaming a certification, you will likely want to rename the associated superblock along with it. Do the following to rename only the certificate:
|
||||
|
||||
1. Rename the `curriculum/challenges/_meta/{superBlock}-certficate` folder to the new name.
|
||||
1. In the `meta.json` file of that folder, rename the values in `name`, `dashedName`, and `challengeOrder` to the new cert name.
|
||||
1. In `curriculum/challenges/english/12-certificate`, rename the `{superBlock}-certificate` folder, and the YAML file within it, to the new name.
|
||||
1. In the YAML file, change the `title` to the new name.
|
||||
1. Rename the file and folder from step 3 for the rest curriculum languages.
|
||||
1. Update `client/src/redux/index.ts` to use the correct `title`.
|
||||
1. Optionally, update the `certSlug` for the superblock in the same file. **Note** that renaming a `certSlug` will change the URL for certifications and should only be done with careful consideration.
|
||||
1. Update the `title` in `client/src/resources/cert-and-project-map.ts` to the new value. **Note** that changing the `title` here **will break** the superBlock page for the associated certification. It relies on the superBlock title to match the certification title. You will likely want to rename the superBlock at the same time.
|
||||
1. If you renamed the `certSlug` in step 7, change it here for the cert and all the nested `projects` values.
|
||||
1. In `config/certification-settings.js`, update the value of `certTypeTitleMap` to the new name.
|
||||
1. If you renamed the `certSlug` in step 7, update the key of `certSlugTypeMap` in the same file.
|
||||
1. Update the certificate name in the `legacyCerts` array of the `client/src/client-only-routes/show-project-links.tsx` if needed.
|
||||
1. Update the main `README.md` file to the new name.
|
||||
|
||||
### Renaming a Superblock
|
||||
|
||||
> [!NOTE] When you rename a superBlock, the new folder name is used as the path and should be considered the "correct" name. All other values should be updated to reflect that change.
|
||||
|
||||
Also, you will likely want to rename the certificate and the `{superBlock}-projects` block when you rename a superBlock since they all shares a name. To rename only a superBlock you need to:
|
||||
|
||||
1. Rename the superBlock folder in the `curriculum/challenges/english` directory.
|
||||
1. Rename the superBlock folder in *all* other `curriculum/challenges/{language}` directories.
|
||||
1. For each block within that superBlock, update the `superBlock` value in the `meta.json` file to its dashedName. You don't need to rename any folders here. Do that when renaming a block.
|
||||
1. Rename the superblock folder in `client/src/pages/learn`.
|
||||
1. Update the `index.md` file in the above folder, changing the `title` and `superBlock` values to the new name.
|
||||
1. For each block folder within the above, update the `index.md` to use the correct `superBlock` value.
|
||||
1. In the `client/src/resources/cert-and-project-map.ts` file, update the path for the cert at the top of the file, and the `title` value for that superBlock. **Note** that changing the `title` here **will break** the ability to view the actual certification for this superBlock. It relies on the superBlock title to match the certification title. You will likely want to rename the certification at the same time.
|
||||
1. Update the `superBlockCertTypeMap` key in `config/certification-settings.js` to the new superBlock name.
|
||||
1. Update the path value in `client/src/assets/icons/index.tsx`.
|
||||
1. For each language in `client/i18n/locales`, update the `intro.json` file to use the new superBlock `dashedName`. In the English file, also update the `title`.
|
||||
1. Check the `config/i18n/all-langs.js` file to see if the superBlock is enabled in i18n builds. Update all the values where it is used.
|
||||
1. Update the main `README.md` file to the new name.
|
||||
|
||||
### Renaming a Block
|
||||
|
||||
When renaming a curriculum block, you need to:
|
||||
|
||||
1. Change the name of the block folder in the `curriculum/challenges/english/{superBlock}` directory.
|
||||
1. Change the name of the same block folder in *all* of the other language directories to match. These must all be the same as the English structure or the build will error out.
|
||||
1. Change the name of the block folder in the `_meta` directory.
|
||||
1. Update the `name` and `dashedName` property for that block's `meta.json` file.
|
||||
1. Update the `client/utils/help-category-map.json` to use the new block name as the key.
|
||||
1. Update the block folder in `client/src/pages/learn/{superBlock}`.
|
||||
1. In the `index.md` file of the above folder, update the `block` value in the frontmatter.
|
||||
1. In the `client/i18n/locales/{language}/intro.json` files, update the block name to the new name for all the languages. In the English `intro.json` file, update the `title` as well.
|
||||
1. Update the main `README.md` file to the new name.
|
||||
|
||||
### Renaming a Challenge
|
||||
|
||||
When renaming a single challenge file, you need to:
|
||||
|
||||
1. Change the name of the challenge file in the `curriculum/challenges/english` directory.
|
||||
1. Change the name of the `title` and `dashedName` within that file.
|
||||
1. Change the of the file, and the `dashedName` in those files for *all* of the other language directories to match.
|
||||
1. Update the name of the challenge in the relevant `meta.json` file. The challenge names here are not used in the build, but provide a user-friendly way to identify the challenge order.
|
||||
1. If the challenge is a certificate project, update the YAML file in `curriculum/english/12-certificates/<superBlock>` to the new name.
|
||||
1. If the challenge is a certificate project, update the main `README.md` file to the new name.
|
||||
|
||||
## The `dashedName` Property
|
||||
|
||||
The `dashedName` property is used to generate the URL path for the superblock, block, or challenge. These should generally match what the `/utils/dasherize.js` helper would output for the file name.
|
||||
@ -203,7 +203,7 @@ Il team di sviluppo fa un merge dei cambiamenti dal ramo `prod-staging` a `prod-
|
||||
|
||||
Ci sono alcune limitazioni e compromessi noti quando si utilizza la versione beta della piattaforma.
|
||||
|
||||
- #### Tutti i dati / progressi personali su queste piattaforme beta `NON saranno salvati o riportati` alla produzione.
|
||||
- #### All data / personal progress on these beta platforms will NOT be saved or carried over to production.
|
||||
|
||||
**Gli utenti nella versione beta avranno un account separato dalla produzione.** La versione beta utilizza un database fisicamente separato dalla produzione. Questo ci dà la possibilità di prevenire qualsiasi perdita accidentale di dati o modifiche. Il team di sviluppo può eliminare il database su questa versione beta se necessario.
|
||||
|
||||
|
||||
@ -85,7 +85,7 @@ part-6.md
|
||||
|
||||
A un certo punto decidi che hai bisogno di eliminare `part-2.md`, perché quel passo non è più necessario. Inoltre, decidi di dividere `part-4.md` in tre passi invece di uno.
|
||||
|
||||
Per ottenere questa ristrutturazione, avresti bisogno di eliminare `part-2.md` e poi aggiungere un `part-4a.md` e un `part-5b.md`. La nuova struttura della cartella assomiglierà alla seguente:
|
||||
To accomplish this restructure, you would need to delete `part-2.md` and then add a `part-4a.md` and a `part-4b.md`. La nuova struttura della cartella assomiglierà alla seguente:
|
||||
|
||||
```bash
|
||||
part-001.md
|
||||
|
||||
@ -111,7 +111,7 @@ A volte ci sarà un conflitto di merge.
|
||||
|
||||
Ciò significa che un'altra pull request ha apportato una modifica alla stessa parte di quello stesso file. GitHub ha uno strumento per affrontare questi conflitti di unione direttamente su GitHub. Puoi provare ad affrontare questi conflitti. Usa il tuo miglior giudizio.
|
||||
|
||||
Le modifiche della pull request saranno in alto e le modifiche del ramo Master saranno in basso. A volte ci saranno informazioni ridondanti che possono essere cancellate. Prima di finire, assicura di cancellare i simboli `<<<<<<`, `======`, e `>>>>>>` che Git aggiunge per indicare le aree in conflitto.
|
||||
The pull request's changes will be on top, and the main branch's changes will be on the bottom. A volte ci saranno informazioni ridondanti che possono essere cancellate. Prima di finire, assicura di cancellare i simboli `<<<<<<`, `======`, e `>>>>>>` che Git aggiunge per indicare le aree in conflitto.
|
||||
|
||||
Se non sei sicuro, chiedi assistenza a uno degli altri moderatori o al team di sviluppo.
|
||||
|
||||
@ -409,7 +409,7 @@ git remote add upstream git://github.com/freeCodeCamp/freeCodeCamp.git
|
||||
|
||||
git fetch upstream
|
||||
|
||||
git pull upstream master
|
||||
git pull upstream main
|
||||
````
|
||||
|
||||
Se stai usando una GUI, puoi semplicemente cercare il comando `Add a new remote...` e usare il link `git://github.com/freeCodeCamp/freeCodeCamp.git` visto sopra.
|
||||
|
||||
@ -19,6 +19,7 @@
|
||||
- [Ajude na tradução da aplicação web](how-to-work-on-localized-client-webapp.md)
|
||||
- [Capture e-mails enviados localmente](how-to-catch-outgoing-emails-locally.md)
|
||||
- [Teste traduções localmente](how-to-test-translations-locally.md)
|
||||
- [Understand the curriculum file structure](curriculum-file-structure.md)
|
||||
|
||||
---
|
||||
|
||||
|
||||
104
docs/i18n/portuguese/curriculum-file-structure.md
Normal file
104
docs/i18n/portuguese/curriculum-file-structure.md
Normal file
@ -0,0 +1,104 @@
|
||||
# Curriculum File Structure
|
||||
|
||||
Our core instructional content is located within the conveniently named `curriculum` directory. This page will break down how these files are organized.
|
||||
|
||||
## Terminology
|
||||
|
||||
There are a few terms we use when discussing our curriculum content.
|
||||
|
||||
- `certification` : When referring to a certification in this instance, it is talking about the actual certificate that users claim. Which is separate from the name of the superBlock.
|
||||
- `superBlock` : A superblock is the top level collection of challenges. Each superblock corresponds to a certification in the curriculum (i.e. Responsive Web Design).
|
||||
- `block` : A block is a section within a superblock. A block corresponds to a group of challenges in a given certification (i.e. Basic HTML and HTML5)
|
||||
- `challenge` : A challenge is a single lesson within the curriculum (i.e. Say Hello to HTML Elements)
|
||||
|
||||
## File Tree
|
||||
|
||||
Using those terms, here is how the file structure would be defined:
|
||||
|
||||
```md
|
||||
|
||||
curriculum/
|
||||
├─ _meta/
|
||||
│ ├─ {block}/
|
||||
│ │ ├─ meta.json
|
||||
├─ {language}/
|
||||
│ ├─ {superBlock}/
|
||||
│ │ ├─ {block}/
|
||||
│ │ │ ├─ {challenge}.md
|
||||
```
|
||||
|
||||
## The `_meta` Directory
|
||||
|
||||
The `_meta` directory is a special directory which contains `.json` files. These files correspond to each block in the curriculum, and are used to determine which superBlock a block belongs to, and the order of the challenges within that block.
|
||||
|
||||
## Renaming Files
|
||||
|
||||
There may be times when you need to rename a certificate, superblock, block, or challenge. This section will outline the steps needed to avoid build errors when doing so.
|
||||
|
||||
> [!ATTENTION] Renaming files within the curriculum structure will often change the path (or URL) of the content on the main webpage. Doing so should be done with care, as redirects have to be set up for each change that is made.
|
||||
|
||||
### Renaming a Certification
|
||||
|
||||
When renaming a certification, you will likely want to rename the associated superblock along with it. Do the following to rename only the certificate:
|
||||
|
||||
1. Rename the `curriculum/challenges/_meta/{superBlock}-certficate` folder to the new name.
|
||||
1. In the `meta.json` file of that folder, rename the values in `name`, `dashedName`, and `challengeOrder` to the new cert name.
|
||||
1. In `curriculum/challenges/english/12-certificate`, rename the `{superBlock}-certificate` folder, and the YAML file within it, to the new name.
|
||||
1. In the YAML file, change the `title` to the new name.
|
||||
1. Rename the file and folder from step 3 for the rest curriculum languages.
|
||||
1. Update `client/src/redux/index.ts` to use the correct `title`.
|
||||
1. Optionally, update the `certSlug` for the superblock in the same file. **Note** that renaming a `certSlug` will change the URL for certifications and should only be done with careful consideration.
|
||||
1. Update the `title` in `client/src/resources/cert-and-project-map.ts` to the new value. **Note** that changing the `title` here **will break** the superBlock page for the associated certification. It relies on the superBlock title to match the certification title. You will likely want to rename the superBlock at the same time.
|
||||
1. If you renamed the `certSlug` in step 7, change it here for the cert and all the nested `projects` values.
|
||||
1. In `config/certification-settings.js`, update the value of `certTypeTitleMap` to the new name.
|
||||
1. If you renamed the `certSlug` in step 7, update the key of `certSlugTypeMap` in the same file.
|
||||
1. Update the certificate name in the `legacyCerts` array of the `client/src/client-only-routes/show-project-links.tsx` if needed.
|
||||
1. Update the main `README.md` file to the new name.
|
||||
|
||||
### Renaming a Superblock
|
||||
|
||||
> [!NOTE] When you rename a superBlock, the new folder name is used as the path and should be considered the "correct" name. All other values should be updated to reflect that change.
|
||||
|
||||
Also, you will likely want to rename the certificate and the `{superBlock}-projects` block when you rename a superBlock since they all shares a name. To rename only a superBlock you need to:
|
||||
|
||||
1. Rename the superBlock folder in the `curriculum/challenges/english` directory.
|
||||
1. Rename the superBlock folder in *all* other `curriculum/challenges/{language}` directories.
|
||||
1. For each block within that superBlock, update the `superBlock` value in the `meta.json` file to its dashedName. You don't need to rename any folders here. Do that when renaming a block.
|
||||
1. Rename the superblock folder in `client/src/pages/learn`.
|
||||
1. Update the `index.md` file in the above folder, changing the `title` and `superBlock` values to the new name.
|
||||
1. For each block folder within the above, update the `index.md` to use the correct `superBlock` value.
|
||||
1. In the `client/src/resources/cert-and-project-map.ts` file, update the path for the cert at the top of the file, and the `title` value for that superBlock. **Note** that changing the `title` here **will break** the ability to view the actual certification for this superBlock. It relies on the superBlock title to match the certification title. You will likely want to rename the certification at the same time.
|
||||
1. Update the `superBlockCertTypeMap` key in `config/certification-settings.js` to the new superBlock name.
|
||||
1. Update the path value in `client/src/assets/icons/index.tsx`.
|
||||
1. For each language in `client/i18n/locales`, update the `intro.json` file to use the new superBlock `dashedName`. In the English file, also update the `title`.
|
||||
1. Check the `config/i18n/all-langs.js` file to see if the superBlock is enabled in i18n builds. Update all the values where it is used.
|
||||
1. Update the main `README.md` file to the new name.
|
||||
|
||||
### Renaming a Block
|
||||
|
||||
When renaming a curriculum block, you need to:
|
||||
|
||||
1. Change the name of the block folder in the `curriculum/challenges/english/{superBlock}` directory.
|
||||
1. Change the name of the same block folder in *all* of the other language directories to match. These must all be the same as the English structure or the build will error out.
|
||||
1. Change the name of the block folder in the `_meta` directory.
|
||||
1. Update the `name` and `dashedName` property for that block's `meta.json` file.
|
||||
1. Update the `client/utils/help-category-map.json` to use the new block name as the key.
|
||||
1. Update the block folder in `client/src/pages/learn/{superBlock}`.
|
||||
1. In the `index.md` file of the above folder, update the `block` value in the frontmatter.
|
||||
1. In the `client/i18n/locales/{language}/intro.json` files, update the block name to the new name for all the languages. In the English `intro.json` file, update the `title` as well.
|
||||
1. Update the main `README.md` file to the new name.
|
||||
|
||||
### Renaming a Challenge
|
||||
|
||||
When renaming a single challenge file, you need to:
|
||||
|
||||
1. Change the name of the challenge file in the `curriculum/challenges/english` directory.
|
||||
1. Change the name of the `title` and `dashedName` within that file.
|
||||
1. Change the of the file, and the `dashedName` in those files for *all* of the other language directories to match.
|
||||
1. Update the name of the challenge in the relevant `meta.json` file. The challenge names here are not used in the build, but provide a user-friendly way to identify the challenge order.
|
||||
1. If the challenge is a certificate project, update the YAML file in `curriculum/english/12-certificates/<superBlock>` to the new name.
|
||||
1. If the challenge is a certificate project, update the main `README.md` file to the new name.
|
||||
|
||||
## The `dashedName` Property
|
||||
|
||||
The `dashedName` property is used to generate the URL path for the superblock, block, or challenge. These should generally match what the `/utils/dasherize.js` helper would output for the file name.
|
||||
@ -203,7 +203,7 @@ Você pode identificar a versão exata implantada visitando os registros de comp
|
||||
|
||||
Existem algumas limitações e desvantagens conhecidas ao usar a versão beta da plataforma.
|
||||
|
||||
- #### Todos os dados/progresso pessoal nessas plataformas beta NÃO serão salvos ou transferidos para a produção.
|
||||
- #### All data / personal progress on these beta platforms will NOT be saved or carried over to production.
|
||||
|
||||
**Os usuários na versão beta terão uma conta separada da produção.** A versão beta usa um banco de dados fisicamente separado da produção. Isso nos dá a capacidade de evitar qualquer perda acidental de dados ou modificações. A equipe de desenvolvimento pode limpar o banco de dados nesta versão beta conforme necessário.
|
||||
|
||||
|
||||
@ -85,7 +85,7 @@ part-6.md
|
||||
|
||||
Em algum momento, você decide que precisa deletar `part-2.md`, porque os passos nele não são mais necessários. Você também decide que vai diluir as partes dentro de `part-4.md` em três passos ao invés de um.
|
||||
|
||||
Para completar essa reestruturação, você precisará deletar `part-2.md` e então adicionar a `part-4a.md` e a `part-5b.md`. A nova estrutura da pasta deve ficar assim:
|
||||
To accomplish this restructure, you would need to delete `part-2.md` and then add a `part-4a.md` and a `part-4b.md`. A nova estrutura da pasta deve ficar assim:
|
||||
|
||||
```bash
|
||||
part-001.md
|
||||
|
||||
@ -111,7 +111,7 @@ Antes de dar merge em qualquer pull request, certifique-se que há um aviso dize
|
||||
|
||||
Isso quer dizer que outro pull request fez mudanças na mesma parte de um arquivo. O GitHub tem uma ferramenta para resolver esses conflitos de merges diretamente no GitHub. Você pode tentar resolver esses conflitos. Apenas use seu melhor julgamento.
|
||||
|
||||
As mudanças do pull request estarão no topo e as mudanças da branch master estarão embaixo. Às vezes, haverá informação redundante que pode ser apagada. Antes de terminar, certifique-se de excluir o `<<<<<<`, `======` e o `>>>>>>` que o Git adiciona para indicar áreas de conflito.
|
||||
The pull request's changes will be on top, and the main branch's changes will be on the bottom. Às vezes, haverá informação redundante que pode ser apagada. Antes de terminar, certifique-se de excluir o `<<<<<<`, `======` e o `>>>>>>` que o Git adiciona para indicar áreas de conflito.
|
||||
|
||||
Se não tem certeza, peça ajuda para algum moderador ou para o time de desenvolvimento.
|
||||
|
||||
@ -402,14 +402,14 @@ Gostaríamos imensamente de poder fazer merge de suas mudanças mas parece que a
|
||||
|
||||
Para resolver esse erro, você terá que sincronizar as últimas mudanças da branch `main` do repositório `freeCodeCamp/freeCodeCamp`.
|
||||
|
||||
Usando a linha de comando, você pode fazer isso em três etapas fáceis:
|
||||
Using the command line, you can do this in three easy steps:
|
||||
|
||||
```bash
|
||||
git remote add upstream git://github.com/freeCodeCamp/freeCodeCamp.git
|
||||
|
||||
git fetch upstream
|
||||
|
||||
git pull upstream master
|
||||
git pull upstream main
|
||||
````
|
||||
|
||||
Se você está usando uma interface, você pode simplesmente usar `Add a new remote...` e usar o link `git://github.com/freeCodeCamp/freeCodeCamp.git`.
|
||||
|
||||
Reference in New Issue
Block a user