From 5cab3724ce4c0ce21fc640cddbf6bdb609daa640 Mon Sep 17 00:00:00 2001 From: camperbot Date: Thu, 1 Dec 2022 07:53:21 -0800 Subject: [PATCH] chore(i18n,docs): processed translations (#48646) --- .../how-to-work-on-the-docs-theme.md | 4 +++- .../chinese/how-to-work-on-the-docs-theme.md | 4 +++- .../espanol/how-to-work-on-the-docs-theme.md | 16 +++++++++------- .../german/how-to-work-on-the-docs-theme.md | 4 +++- .../italian/how-to-work-on-the-docs-theme.md | 18 ++++++++++-------- .../japanese/how-to-work-on-the-docs-theme.md | 14 ++++++++------ .../how-to-work-on-the-docs-theme.md | 18 ++++++++++-------- .../ukrainian/how-to-work-on-the-docs-theme.md | 16 +++++++++------- 8 files changed, 55 insertions(+), 39 deletions(-) diff --git a/docs/i18n/chinese-traditional/how-to-work-on-the-docs-theme.md b/docs/i18n/chinese-traditional/how-to-work-on-the-docs-theme.md index a1c529e5ff3..cffce5ecf77 100644 --- a/docs/i18n/chinese-traditional/how-to-work-on-the-docs-theme.md +++ b/docs/i18n/chinese-traditional/how-to-work-on-the-docs-theme.md @@ -4,6 +4,8 @@ To work on the contributing guidelines, you can edit or add files in the `docs` directory [available here](https://github.com/freeCodeCamp/freeCodeCamp/tree/main/docs). When your changes are merged, they will be made available automatically at the documentation site. +When adding a new file to the `docs` directory, you should evaluate if the file should also be added to the sidebar navigation. We typically create a link in the [`_sidebar.md`](_sidebar.md) file for new and independent guides. Alternatively, You may follow the instructions below on creating an internal link for supporting guides. + ### How to create an internal link If you want to create a link targeting a different section of the contributing guidelines, follow this format: @@ -39,7 +41,7 @@ Typically you would not need to change any configuration or build the site local - We serve this file as a SPA using `docsify` and GitHub Pages. - The `docsify` script generates the content of `markdown` files in the `docs` directory on demand. - The homepage is generated from the [`_coverpage.md`](_coverpage.md). -- the sidebar navigation is generated from [`_sidebar.md`](_sidebar.md). +- The sidebar navigation is generated from [`_sidebar.md`](_sidebar.md). ### Serving the documentation site locally diff --git a/docs/i18n/chinese/how-to-work-on-the-docs-theme.md b/docs/i18n/chinese/how-to-work-on-the-docs-theme.md index a1c529e5ff3..cffce5ecf77 100644 --- a/docs/i18n/chinese/how-to-work-on-the-docs-theme.md +++ b/docs/i18n/chinese/how-to-work-on-the-docs-theme.md @@ -4,6 +4,8 @@ To work on the contributing guidelines, you can edit or add files in the `docs` directory [available here](https://github.com/freeCodeCamp/freeCodeCamp/tree/main/docs). When your changes are merged, they will be made available automatically at the documentation site. +When adding a new file to the `docs` directory, you should evaluate if the file should also be added to the sidebar navigation. We typically create a link in the [`_sidebar.md`](_sidebar.md) file for new and independent guides. Alternatively, You may follow the instructions below on creating an internal link for supporting guides. + ### How to create an internal link If you want to create a link targeting a different section of the contributing guidelines, follow this format: @@ -39,7 +41,7 @@ Typically you would not need to change any configuration or build the site local - We serve this file as a SPA using `docsify` and GitHub Pages. - The `docsify` script generates the content of `markdown` files in the `docs` directory on demand. - The homepage is generated from the [`_coverpage.md`](_coverpage.md). -- the sidebar navigation is generated from [`_sidebar.md`](_sidebar.md). +- The sidebar navigation is generated from [`_sidebar.md`](_sidebar.md). ### Serving the documentation site locally diff --git a/docs/i18n/espanol/how-to-work-on-the-docs-theme.md b/docs/i18n/espanol/how-to-work-on-the-docs-theme.md index 5974432e03b..3d32f9d292c 100644 --- a/docs/i18n/espanol/how-to-work-on-the-docs-theme.md +++ b/docs/i18n/espanol/how-to-work-on-the-docs-theme.md @@ -4,9 +4,11 @@ Para trabajar en las pautas de contribución, puedes editar o agregar archivos al directorio `docs`, [disponible aquí](https://github.com/freeCodeCamp/freeCodeCamp/tree/main/docs). Cuando tus cambios se fusionen, automáticamente estarán disponibles en el sitio de documentación. +When adding a new file to the `docs` directory, you should evaluate if the file should also be added to the sidebar navigation. We typically create a link in the [`_sidebar.md`](_sidebar.md) file for new and independent guides. Alternatively, You may follow the instructions below on creating an internal link for supporting guides. + ### Cómo crear un enlace interno -Si desea crear un enlace dirigido a una sección diferente de las pautas de contribución, siga el siguiente formato: +If you want to create a link targeting a different section of the contributing guidelines, follow this format: ```md [Link text](target-file-name.md#target-section-heading-id) @@ -15,13 +17,13 @@ Si desea crear un enlace dirigido a una sección diferente de las pautas de cont [Link text](#target-section-heading-id) ``` -Asegurate de incluir la extensión del archivo(`.md`). No especifique la URL completa o añada `/` antes del nombre del archivo. +Make sure you include the file extension (`.md`). Don't specify the full URL or append `/` before the file name. -Esto es necesario para que estos enlaces funcionen en la versión traducida del documento. De lo contrario, serán redirigidos a la versión de la pagina en inglés independientemente del idioma. +This is necessary to make these links work for the translated version of the document. Otherwise, they will redirect to the English version of the page regardless of the language. #### Traduciendo archivos con enlaces internos -Cuando traduces documentos en Crowdin, asegurate de reemplazar el `#target-section-heading-id` con el id del documento traducido. [Más información sobre la traducción de documentos aquí](how-to-translate-files.md#translate-documentation). +When you work on translating docs on Crowdin, make sure to replace the `#target-section-heading-id` with the id on the translated document. [Learn more about translating docs here](how-to-translate-files.md#translate-documentation). ## Trabajar en el tema de los documentos @@ -31,15 +33,15 @@ Cuando traduces documentos en Crowdin, asegurate de reemplazar el `#target-secti ### Estructura de los documentos de la página web -El sitio es generado con [`docsify`](https://docsify.js.org) y hosteado por medio de GitHub pages. +The site is generated using [`docsify`](https://docsify.js.org) and served using GitHub pages. -Normalmente no necesitarías modificar ninguna configuración ni compilar el sitio localmente. En caso de que te interese, así es como funciona: +Typically you would not need to change any configuration or build the site locally. In case you are interested, here is how it works: - El código de la página de inicio para este sitio está disponible en [`docs/index.html`](index.html). - Servimos este archivo como SPA utilizando `docsify` y GitHub Pages. - El script `docsify` genera el contenido de los archivos `lenguaje de marcado` en el directorio `docs` en linea. - La página de inicio se genera a partir del [`_coverpage.md`](_coverpage.md). -- La barra de navegación lateral es generada desde [`_sidebar.md`](_sidebar.md). +- The sidebar navigation is generated from [`_sidebar.md`](_sidebar.md). ### Ejecutando el sitio de documentación localmente diff --git a/docs/i18n/german/how-to-work-on-the-docs-theme.md b/docs/i18n/german/how-to-work-on-the-docs-theme.md index 24dafdf08f0..89f0953f099 100644 --- a/docs/i18n/german/how-to-work-on-the-docs-theme.md +++ b/docs/i18n/german/how-to-work-on-the-docs-theme.md @@ -4,6 +4,8 @@ To work on the contributing guidelines, you can edit or add files in the `docs` directory [available here](https://github.com/freeCodeCamp/freeCodeCamp/tree/main/docs). When your changes are merged, they will be made available automatically at the documentation site. +When adding a new file to the `docs` directory, you should evaluate if the file should also be added to the sidebar navigation. We typically create a link in the [`_sidebar.md`](_sidebar.md) file for new and independent guides. Alternatively, You may follow the instructions below on creating an internal link for supporting guides. + ### How to create an internal link If you want to create a link targeting a different section of the contributing guidelines, follow this format: @@ -39,7 +41,7 @@ Typically you would not need to change any configuration or build the site local - Wir stellen diese Datei als SPA (Single Page Application) mit `docsify` und GitHub Pages bereit. - The `docsify` script generates the content of `markdown` files in the `docs` directory on demand. - Die Homepage wird aus der [`_coverpage.md`](_coverpage.md) erstellt. -- die Navigation in der Seitenleiste wird aus [`_sidebar.md`](_sidebar.md) generiert. +- The sidebar navigation is generated from [`_sidebar.md`](_sidebar.md). ### Serving the documentation site locally diff --git a/docs/i18n/italian/how-to-work-on-the-docs-theme.md b/docs/i18n/italian/how-to-work-on-the-docs-theme.md index 14e47afcb27..455d15e4b78 100644 --- a/docs/i18n/italian/how-to-work-on-the-docs-theme.md +++ b/docs/i18n/italian/how-to-work-on-the-docs-theme.md @@ -4,9 +4,11 @@ Per lavorare sulle linee guida per i contributori, puoi modificare o aggiungere file nella cartella `docs` [disponibile qui](https://github.com/freeCodeCamp/freeCodeCamp/tree/main/docs). Quando i tuoi cambiamenti sono accettati, saranno resi disponibili automaticamente nel sito della documentazione. +When adding a new file to the `docs` directory, you should evaluate if the file should also be added to the sidebar navigation. We typically create a link in the [`_sidebar.md`](_sidebar.md) file for new and independent guides. Alternatively, You may follow the instructions below on creating an internal link for supporting guides. + ### Come creare un link interno -Se vuoi creare un link che punta a una sezione diversa della documentazione per contribuire, segui questo formato: +If you want to create a link targeting a different section of the contributing guidelines, follow this format: ```md [Link text](target-file-name.md#target-section-heading-id) @@ -15,13 +17,13 @@ Se vuoi creare un link che punta a una sezione diversa della documentazione per [Link text](#target-section-heading-id) ``` -Assicurati di includere l'estensione del file (`.md`). Non specificare l'URL completo o aggiungere `/` prima del nome del file. +Make sure you include the file extension (`.md`). Don't specify the full URL or append `/` before the file name. -È necessario fare così per rendere questi link funzionanti anche nella versione tradotta del documento. Altrimenti, punterebbero alla versione inglese della pagina a discapito della lingua. +This is necessary to make these links work for the translated version of the document. Otherwise, they will redirect to the English version of the page regardless of the language. #### Tradurre documentazione con link interni -Quando lavori a tradurre la documentazione su Crowdin, assicurati di sostituire la parte `#target-section-heading-id` con l'id del documento tradotto. [Impara di più sul tradurre la documentazione qui](how-to-translate-files.md#tradurre-la-documentazione). +When you work on translating docs on Crowdin, make sure to replace the `#target-section-heading-id` with the id on the translated document. [Learn more about translating docs here](how-to-translate-files.md#translate-documentation). ## Lavorare sul tema della documentazione @@ -31,19 +33,19 @@ Quando lavori a tradurre la documentazione su Crowdin, assicurati di sostituire ### Struttura del sito di documentazione -Il sito viene generato utilizzando [`docsify`](https://docsify.js.org) e servito utilizzando le pagine di GitHub. +The site is generated using [`docsify`](https://docsify.js.org) and served using GitHub pages. -In genere non è necessario modificare alcuna configurazione o costruire il sito localmente. Nel caso in cui tu sia interessato, ecco come funziona: +Typically you would not need to change any configuration or build the site locally. In case you are interested, here is how it works: - La sorgente della homepage per questo sito è disponibile in [`docs/index.html`](index.html). - Serviamo questo file come SPA (Single Page Application) usando `docsify` e GitHub Pages. - Lo script `docsify` genera il contenuto del `file markdown` nella directory `docs` su richiesta. - La homepage è generata dal file [`_coverpage.md`](_coverpage.md). -- la navigazione della barra laterale è generata da [`_sidebar.md`](_sidebar.md). +- The sidebar navigation is generated from [`_sidebar.md`](_sidebar.md). ### Servire localmente il sito di documentazione -Installa freeCodeCamp localmente ([vedi la guida di installazione locale](how-to-setup-freecodecamp-locally)), impacchettiamo il CLI con gli strumenti di sviluppo in modo da poter eseguire uno qualsiasi dei comandi sottostanti dalla root del repo quando necessario: +Install freeCodeCamp locally ([see the local setup guide](how-to-setup-freecodecamp-locally)), we bundled the CLI with the development tools so you can run any of the below commands as needed from the root of the repo: #### Servire e avviare solo il sito di documentazione diff --git a/docs/i18n/japanese/how-to-work-on-the-docs-theme.md b/docs/i18n/japanese/how-to-work-on-the-docs-theme.md index e37cd76d1a0..4b2df7ac533 100644 --- a/docs/i18n/japanese/how-to-work-on-the-docs-theme.md +++ b/docs/i18n/japanese/how-to-work-on-the-docs-theme.md @@ -4,9 +4,11 @@ コントリビューションガイドラインを編集するには、`docs` [ディレクトリ](https://github.com/freeCodeCamp/freeCodeCamp/tree/main/docs) のファイルを編集または追加します。 When your changes are merged, they will be made available automatically at the documentation site. +When adding a new file to the `docs` directory, you should evaluate if the file should also be added to the sidebar navigation. We typically create a link in the [`_sidebar.md`](_sidebar.md) file for new and independent guides. Alternatively, You may follow the instructions below on creating an internal link for supporting guides. + ### 内部リンクを作成する -コントリビューションガイドラインの他セクションをリンク先に設定する場合、次の形式に従ってください。 +If you want to create a link targeting a different section of the contributing guidelines, follow this format: ```md [Link text](target-file-name.md#target-section-heading-id) @@ -15,13 +17,13 @@ [Link text](#target-section-heading-id) ``` -拡張子 (`.md`) を必ず含めてください。 URL 全体を指定したり、ファイル名の前に `/` を付けたりしないでください。 +Make sure you include the file extension (`.md`). Don't specify the full URL or append `/` before the file name. -上記は翻訳版のドキュメントでリンクが動作するために必要です。 この形式に従わないリンクは、言語に関係なく英語版のページにリダイレクトされます。 +This is necessary to make these links work for the translated version of the document. Otherwise, they will redirect to the English version of the page regardless of the language. #### 内部リンクのあるドキュメントを翻訳する -Crowdin でドキュメントの翻訳を行う際には、`#target-section-heading-id` を翻訳版のドキュメント上の id と置き換えてください。 [ドキュメントの翻訳について詳しくはこちらを参照してください](how-to-translate-files.md#ドキュメントを翻訳する)。 +When you work on translating docs on Crowdin, make sure to replace the `#target-section-heading-id` with the id on the translated document. [Learn more about translating docs here](how-to-translate-files.md#translate-documentation). ## ドキュメントのテーマに貢献する @@ -33,13 +35,13 @@ Crowdin でドキュメントの翻訳を行う際には、`#target-section-head The site is generated using [`docsify`](https://docsify.js.org) and served using GitHub pages. -通常、サイトの設定を変更したり、サイトをローカルにビルドしたりする必要はありません。 参考までに、以下のように動作します。 +Typically you would not need to change any configuration or build the site locally. In case you are interested, here is how it works: - このサイト向けのホームページのソースは、[`docs/index.html`](index.html) にあります。 - `docsify` と GitHub Pages を使用して、このファイルを SPA として提供します。 - The `docsify` script generates the content of `markdown` files in the `docs` directory on demand. - ホームページは [`_coverpage.md`](_coverpage.md) から生成されます。 -- サイドバーナビゲーションは [`_sidebar.md`](_sidebar.md) から生成されます。 +- The sidebar navigation is generated from [`_sidebar.md`](_sidebar.md). ### ローカルでドキュメントサイトを提供する diff --git a/docs/i18n/portuguese/how-to-work-on-the-docs-theme.md b/docs/i18n/portuguese/how-to-work-on-the-docs-theme.md index b091015e9a2..ed33e4b1dee 100644 --- a/docs/i18n/portuguese/how-to-work-on-the-docs-theme.md +++ b/docs/i18n/portuguese/how-to-work-on-the-docs-theme.md @@ -4,9 +4,11 @@ Para trabalhar nas diretrizes de contribuição, você pode editar ou adicionar arquivos no diretório `docs` [disponível aqui](https://github.com/freeCodeCamp/freeCodeCamp/tree/main/docs). Ao fazermos o merge de suas alterações, elas são disponibilizadas automaticamente no site da documentação. +When adding a new file to the `docs` directory, you should evaluate if the file should also be added to the sidebar navigation. We typically create a link in the [`_sidebar.md`](_sidebar.md) file for new and independent guides. Alternatively, You may follow the instructions below on creating an internal link for supporting guides. + ### Como criar um link interno -Se você quiser criar um link direcionando a uma outra seção das diretrizes de contribuição, siga este formato: +If you want to create a link targeting a different section of the contributing guidelines, follow this format: ```md [Link text](target-file-name.md#target-section-heading-id) @@ -15,13 +17,13 @@ Se você quiser criar um link direcionando a uma outra seção das diretrizes de [texto do link](#id-do-cabeçalho-da-seção-de-destino) ``` -Certifique-se de incluir a extensão de arquivo (`.md`). Não especifique o URL completo nem acrescente `/` antes do nome do arquivo. +Make sure you include the file extension (`.md`). Don't specify the full URL or append `/` before the file name. -Isso é necessário para que esses links funcionem para a versão traduzida do documento. Caso contrário, eles redirecionarão para a versão em inglês da página, independentemente do idioma. +This is necessary to make these links work for the translated version of the document. Otherwise, they will redirect to the English version of the page regardless of the language. #### Traduzindo a documentação com links internos -Ao trabalhar na tradução da documentação no Crowdin, certifique-se de substituir o `#target-section-heading-id` (id do cabeçalho da seção de destino) pelo id no documento traduzido. [Saiba mais sobre como traduzir a documentação aqui](how-to-translate-files.md#translate-documentation). +When you work on translating docs on Crowdin, make sure to replace the `#target-section-heading-id` with the id on the translated document. [Learn more about translating docs here](how-to-translate-files.md#translate-documentation). ## Trabalhe no tema da documentação @@ -31,19 +33,19 @@ Ao trabalhar na tradução da documentação no Crowdin, certifique-se de substi ### Estrutura do site da documentação -O site é gerado usando [`docsify`](https://docsify.js.org) e veiculado usando GitHub Pages. +The site is generated using [`docsify`](https://docsify.js.org) and served using GitHub pages. -Normalmente, você não precisaria alterar nenhuma configuração ou compilar o site localmente. Caso esteja interessado, funciona assim: +Typically you would not need to change any configuration or build the site locally. In case you are interested, here is how it works: - A fonte da página inicial para este site está disponível em [`docs/index.html`](index.html). - Veiculamos este arquivo como uma SPA usando `docsify` e GitHub Pages. - O script do `docsify` gera o conteúdo dos arquivos em `markdown` no diretório `docs` sob demanda. - A página inicial é gerada a partir do [`_coverpage.md`](_coverpage.md). -- a navegação da barra lateral é gerada a partir de [`_sidebar.md`](_sidebar.md). +- The sidebar navigation is generated from [`_sidebar.md`](_sidebar.md). ### Veiculando localmente o site da documentação -Instale o freeCodeCamp localmente ([veja o guia de instalação local](how-to-setup-freecodecamp-locally)). Nós empacotamos a CLI com as ferramentas de desenvolvimento para que você possa executar qualquer um dos comandos abaixo, conforme necessário, a partir da raiz do repositório: +Install freeCodeCamp locally ([see the local setup guide](how-to-setup-freecodecamp-locally)), we bundled the CLI with the development tools so you can run any of the below commands as needed from the root of the repo: #### Veicule e inicie apenas o site da documentação diff --git a/docs/i18n/ukrainian/how-to-work-on-the-docs-theme.md b/docs/i18n/ukrainian/how-to-work-on-the-docs-theme.md index 9877c5369da..edf243a9f0c 100644 --- a/docs/i18n/ukrainian/how-to-work-on-the-docs-theme.md +++ b/docs/i18n/ukrainian/how-to-work-on-the-docs-theme.md @@ -4,9 +4,11 @@ Щоб працювати над рекомендаціями щодо внеску, ви можете редагувати або додавати файли в каталозі `docs`, [доступному тут](https://github.com/freeCodeCamp/freeCodeCamp/tree/main/docs). Коли ваші зміни об'єднані, вони стануть автоматично доступними на документаційному сайті. +When adding a new file to the `docs` directory, you should evaluate if the file should also be added to the sidebar navigation. We typically create a link in the [`_sidebar.md`](_sidebar.md) file for new and independent guides. Alternatively, You may follow the instructions below on creating an internal link for supporting guides. + ### Як створити внутрішнє посилання -Якщо ви хочете створити внутрішнє посилання, націлене на інший розділ рекомендацій щодо внеску, слідуйте цьому формату: +If you want to create a link targeting a different section of the contributing guidelines, follow this format: ```md [Link text](target-file-name.md#target-section-heading-id) @@ -15,13 +17,13 @@ [Link text](#target-section-heading-id) ``` -Переконайтеся, що включили розширення файлу (`.md`). Не вказуйте повну URL-адресу або додайте `/` перед назвою файлу. +Make sure you include the file extension (`.md`). Don't specify the full URL or append `/` before the file name. -Це обов'язково для того, щоб посилання працювали для перекладеної версії документа. В іншому випадку вони перенаправлятимуть на англійську версію сторінки, незалежно від мови. +This is necessary to make these links work for the translated version of the document. Otherwise, they will redirect to the English version of the page regardless of the language. #### Переклад документації з внутрішніми посиланнями -Коли ви працюєте над перекладом документації на Crowdin, не забудьте змінити `#target-section-heading-id` на ідентифікацію в перекладеному документі. [Дізнатись більше про переклад документації](how-to-translate-files.md#translate-documentation). +When you work on translating docs on Crowdin, make sure to replace the `#target-section-heading-id` with the id on the translated document. [Learn more about translating docs here](how-to-translate-files.md#translate-documentation). ## Робота над темою документації @@ -31,15 +33,15 @@ ### Структура вебсайту документації -Сайт створений з використанням [`docsify`](https://docsify.js.org) та обслуговується завдяки GitHub Pages. +The site is generated using [`docsify`](https://docsify.js.org) and served using GitHub pages. -Зазвичай вам не потрібно буде змінювати конфігурації або створювати сайт локально. Хочете дізнатись більше? Ось як це працює: +Typically you would not need to change any configuration or build the site locally. In case you are interested, here is how it works: - Джерело домашньої сторінки для цього сайту доступне в [`docs/index.html`](index.html). - Ми обслуговуємо цей файл як SPA, використовуючи `docsify` та GitHub Pages. - Скрипт `docsify` генерує вміст файлів `markdown` в каталозі `docs` за запитом. - Домашня сторінка генерується з [`_coverpage.md`](_coverpage.md). -- Навігація бічної панелі генерується з [`_sidebar.md`](_sidebar.md). +- The sidebar navigation is generated from [`_sidebar.md`](_sidebar.md). ### Обслуговування документаційного сайту локально