Pular para o conteúdo principal

Contribuições para traduções

Ajude a tornar o WordPress Playground acessível a um público global traduzindo sua documentação. Este guia fornece tudo o que você precisa saber para começar. Contribuir com traduções segue o mesmo fluxo de trabalho que qualquer outra alteração de documentação. Você pode fazer um fork do repositório WordPress/wordpress-playground e criar um pull request (PR) com suas alterações, ou editar páginas diretamente usando a interface do GitHub.

informação

Para um guia detalhado sobre o fluxo de trabalho de contribuição (fork, criação de PRs, etc.), consulte nosso guia de contribuição para documentação

Como funcionam as traduções​

O site de documentação do Playground é construído com Docusaurus, que gerencia os recursos de internacionalização (i18n).

informação

Para saber mais sobre como o Docusaurus gerencia traduções, consulte a seção de Internacionalização da documentação oficial do Docusaurus.

Configuração​

Os idiomas disponíveis são definidos no arquivo packages/docs/site/docusaurus.config.js. Por exemplo:

i18n: {
  defaultLocale: 'en',
  path: 'i18n',
  locales: ['en', 'fr'],
  localeConfigs: {
	en: {
		label: 'English',
		path: 'en',
	},
	fr: {
		label: 'French',
		path: 'fr',
	},
  },
}

Estrutura de arquivos​

Todas as páginas de documentação traduzidas estão localizadas no diretório packages/docs/site/i18n/, organizadas por código de idioma.

Para que um idioma funcione corretamente, sua estrutura de arquivos deve espelhar a documentação original em inglês encontrada em packages/docs/site/docs.

Por exemplo, a tradução em espanhol (es) de docs/main/intro.md deve ser colocada em: packages/docs/site/i18n/es/docusaurus-plugin-content-docs/current/main/intro.md.

Se um arquivo traduzido não existir para um idioma específico, o Docusaurus automaticamente recorrerá à versão em inglês dessa página.

Gerando arquivos de tradução​

Ao adicionar um novo idioma, você pode gerar os arquivos JSON necessários para strings da interface do usuário (como rótulos de botões e itens de navegação) executando o seguinte comando do diretório packages/docs/site:

npm run write-translations -- --locale <LANGUAGE_CODE>

Com a configuração adequada do i18n no docusaurus.config.js e arquivos sob i18n, ao executar npm run build:docs da raiz do projeto, pastas específicas sob dist para cada idioma serão criadas.

Testando traduções localmente​

Para visualizar suas alterações para um idioma existente:

  1. Modifique ou adicione um arquivo traduzido no diretório de idioma apropriado, como packages/docs/site/i18n/es/docusaurus-plugin-content-docs/current/.
  2. Do diretório /packages/docs/site, execute o servidor de desenvolvimento local para seu idioma de destino. Por exemplo, para testar espanhol (es):

npm run dev -- --locale es

O seletor de idioma​

O seletor de idioma é um menu suspenso que permite aos usuários selecionar seu idioma preferido.

Seletor de idioma da documentação

Tornando um idioma publicamente disponível no seletor de idioma​

Recomendamos apenas adicionar um idioma ao seletor quando uma porção significativa da documentação foi traduzida. Isso evita uma experiência de usuário ruim onde mudar para um novo idioma resulta em ver principalmente conteúdo em inglês não traduzido.

Como uma diretriz, um idioma deve ser tornado publicamente disponível no seletor apenas quando todo o hub de "Documentação" estiver traduzido, incluindo estas seções principais:

Todos os idiomas estão disponíveis assim que a configuração i18n para um idioma estiver completa e a estrutura de arquivos correta estiver em vigor sob i18n.

Assumindo que o idioma fr seja o primeiro idioma com as páginas do hub de Documentação (Guia de Início Rápido, Instância web do Playground, Sobre o Playground, Guias,...) completamente traduzidas para Francês, o docusaurus.config.js deve ficar assim nesse branch para que npm run build:docs gere adequadamente o subsite fr e exiba apenas o idioma francês no seletor de idioma localeDropdown:

  {
    "i18n": {
      "defaultLocale": "en",
      "path": "i18n",
      "locales": [
        "en",
        "fr"
      ],
      "localeConfigs": {
        "en": {
          "label": "English",
          "path": "en"
        },
        "fr": {
          "label": "French",
          "path": "fr"
        }
      }
    }
  },
  {
    "type": "localeDropdown",
    "position": "right"
  }

Fluxo de trabalho de tradução​

Siga estes passos para traduzir uma página:

  1. Verificar se existe uma issue de tradução existente: Primeiro, pesquise as issues do repositório para ver se já existe uma issue de rastreamento para o idioma desejado. Se existir, comente na issue para reivindicar a(s) página(s) que você gostaria de traduzir.
  2. Criar uma nova issue de tradução: Se não existir nenhuma issue, por favor crie uma nova para rastrear o progresso da tradução para o idioma. Você pode modelá-la de acordo com a issue #2202 e usar a lista de verificação em markdown abaixo para rastrear o progresso.
  3. Traduzir o arquivo:

.

  • The assets are listed at packages/docs/site/static/img/ only place assets inside the translation folder when it requires localized content.

  • Once the translations are ready, check if the docs build script is running properly npm run build:docs. -->

  • Verifique se você tem a versão mais recente da documentação

  • Copie o arquivo .md original de packages/docs/site/docs/... para o caminho correspondente no diretório do idioma (por exemplo, packages/docs/site/i18n/<LANGUAGE_CODE>/...). É crucial replicar a estrutura de arquivos original.

  • Traduza o conteúdo do novo arquivo, mantendo o conteúdo original comentado <!-- English Content -->.

  • Os recursos estão listados em packages/docs/site/static/img/ apenas coloque recursos dentro da pasta de tradução quando necessitar de conteúdo localizado.

  • Assim que as traduções estiverem prontas, verifique se o script de compilação de documentação está sendo executado corretamente npm run build:docs.

  1. Criar um pull request com suas alterações
  • Adicione um prefixo ao título [i18n] para ajudar a identificar as traduções
  • Descreva as páginas que você traduziu
  • Solicite uma revisão em #playground ou #polyglots no wordpress.slack.com
informação

Recomendamos enfaticamente enviar pull requests com um pequeno número de páginas traduzidas. Esta abordagem simplifica o processo de revisão e permite uma integração mais gradual e gerenciável do seu trabalho.

Modelo de rastreamento de tradução​

Você pode usar o seguinte markdown em sua issue de rastreamento:

## Remaining translation pages

<details open>
<summary><h3>Main</h3></summary>

- about
  - [ ] build.md
  - [ ] index.md
  - [ ] launch.md
  - [ ] test.md
- contributing
  - [ ] code.md
  - [ ] coding-standards.md
  - [ ] contributor-badge.md
  - [ ] contributor-day.md
  - [ ] contributor-day-table-lead.md
  - [ ] documentation.md
  - [ ] index.md
  - [ ] releases.md
  - [ ] translations.md
- guides
  - [ ] for-plugin-developers.md
  - [ ] for-theme-developers.md
  - [ ] github-action-pr-preview.md
  - [ ] index.md
  - [ ] providing-content-for-your-demo.md
  - [ ] wordpress-native-ios-app.md
- [ ] changelog.md
- [ ] intro.md
- [ ] quick-start-guide.md
- [ ] resources.md
- [ ] web-instance.md

</details>

<details open>
<summary><h3>Blueprints</h3></summary>

- [ ] 01-index.md
- [ ] 02-using-blueprints.md
- [ ] 03-data-format.md
- [ ] 04-resources.md
- [ ] 05-steps.md
- [ ] 05-steps-shorthands.md
- [ ] 06-bundles.md
- [ ] 07-json-api-and-function-api.md
- [ ] 08-examples.md
- [ ] 09-troubleshoot-and-debug-blueprints.md
- [ ] intro.md
- tutorial
  - [ ] 01-what-are-blueprints-what-you-can-do-with-them.md
  - [ ] 02-how-to-load-run-blueprints.md
  - [ ] 03-build-your-first-blueprint.md
  - [ ] index.md

</details>

<details open>
<summary><h3>Developers</h3></summary>

- 03-build-an-app
  - [ ] 01-index.md
- 05-local-development
  - [ ] 01-wp-now.md
  - [ ] 02-vscode-extension.md
  - [ ] 03-php-wasm-node.md
  - [ ] 04-wp-playground-cli.md
  - [ ] intro.md
- 06-apis
  - [ ] 01-index.md
  - javascript-api
    - [ ] 01-index.md
    - [ ] 02-index-html-vs-remote-html.md
    - [ ] 03-playground-api-client.md
    - [ ] 04-blueprint-json-in-api-client.md
    - [ ] 05-blueprint-functions-in-api-client.md
    - [ ] 06-mount-data.md
  - query-api
    - [ ] 01-index.md
- 07-xdebug
  - [ ] 01-introduction.md
  - [ ] 02-getting-started.md
- 23-architecture
  - [ ] 01-index.md
  - [ ] 02-wasm-php-overview.md
  - [ ] 03-wasm-php-compiling.md
  - [ ] 04-wasm-php-javascript-module.md
  - [ ] 05-wasm-php-filesystem.md
  - [ ] 07-wasm-asyncify.md
  - [ ] 08-browser-concepts.md
  - [ ] 09-browser-tab-orchestrates-execution.md
  - [ ] 10-browser-iframe-rendering.md
  - [ ] 11-browser-php-worker-threads.md
  - [ ] 12-browser-service-workers.md
  - [ ] 13-browser-scopes.md
  - [ ] 14-browser-cross-process-communication.md
  - [ ] 15-wordpress.md
  - [ ] 16-wordpress-database.md
  - [ ] 17-browser-wordpress.md
  - [ ] 18-host-your-own-playground.md
- 24-limitations
  - [ ] 01-index.md
- [ ] intro-devs.md

</details>

Traduzindo com a interface web do GitHub​

Se você preferir não usar ferramentas de desenvolvedor, pode facilmente contribuir com traduções diretamente no site do GitHub. Tudo que você precisa é uma conta gratuita do GitHub.

Este guia mostrará como atualizar uma tradução existente e adicionar uma nova.

Atualizando uma tradução existente​

  1. Navegue até o arquivo. Vá para o repositório e encontre o arquivo que deseja atualizar. Os arquivos de tradução estão localizados em uma pasta nomeada de acordo com seu código de idioma. Por exemplo, todas as traduções em francês estão em packages/docs/site/i18n/fr/docusaurus-plugin-content-docs/current/.
  1. Abra o editor. Selecione o arquivo que deseja editar e clique no ícone de lápis (Edit this file) no canto superior direito. Editando tradução existente
  1. Faça fork do repositório. O GitHub automaticamente solicitará que você Fork this repository. Isso cria uma cópia pessoal para você editar com segurança. Clique no botão para prosseguir.
  1. Faça suas alterações. O editor abrirá em seu navegador. Atualize o texto com suas traduções melhoradas.
  1. Proponha suas alterações. Quando terminar, role até a parte inferior da página. Adicione um título breve e uma descrição de suas alterações (por exemplo, "Corrigindo erros de digitação na tradução em francês") e clique no botão Propose changes.
  1. Crie um Pull Request. Na próxima tela, clique no botão Create pull request. Isso enviará suas alterações aos mantenedores do projeto para revisão.

Adicionando uma nova tradução​

  1. Determine o caminho correto do arquivo. O caminho e o nome do novo arquivo devem espelhar o arquivo original em inglês.
    • Original em inglês: packages/docs/site/docs/main/contributing/documentation.md
    • Tradução em francês: packages/docs/site/i18n/fr/docusaurus-plugin-content-docs/current/main/contributing/documentation.md
  1. Crie o novo arquivo. Navegue até a pasta de idioma correta (por exemplo, /packages/docs/site/i18n/fr/docusaurus-plugin-content-docs/current/). Clique em Add file > Create new file. Criando uma nova tradução
    • Dica profissional: Na caixa de nome do arquivo, você pode criar novas pastas digitando o nome da pasta seguido por /. Por exemplo, digitar main/contributing/documentation.md criará as pastas main e contributing automaticamente.
  1. Faça fork do repositório. Assim como antes, o GitHub solicitará que você Fork this repository. Clique no botão para criar sua cópia pessoal.

Ceci est le contenu traduit en français.


![GitHub UI Editor](@site/static/img/contributing/editor-github-ui.webp)

-->

4.  **Adicione o conteúdo traduzido.** O editor abrirá com um arquivo vazio. Para a conveniência dos revisores, por favor copie o conteúdo do arquivo original em inglês e cole-o em seu novo arquivo, envolvendo-o em tags de comentário. Adicione sua tradução abaixo.

```markdown
<!--
This is the original English content.
It helps reviewers understand the context of the translation.
-->

Este é o conteúdo traduzido em português.

Editor de UI do GitHub

  1. Confirme o novo arquivo. Quando terminar, role até a parte inferior. Adicione um título para seu novo arquivo (por exemplo, "Adicionar tradução em francês para documentation.md") e clique no botão Commit new file.
  1. Crie um Pull Request. Na próxima tela, clique em Create pull request para enviar sua nova tradução para revisão.

Processo de revisão​

Para simplificar o processo de revisão, mantenha o texto original em inglês como um comentário diretamente acima do conteúdo traduzido.

👋 Olá! Bem vindo a documentação oficial do WordPress Playground.

WordPress Playground é uma ferramenta online onde podes testar e aprender mais sobre o WordPress. Nesta página(Documentação) irá encontrar todas as informações necessárias para começar a trabalhar com o Playground.

-->

👋 Olá! Bem-vindo à documentação oficial do WordPress Playground.

WordPress Playground é uma ferramenta online onde você pode testar e aprender mais sobre o WordPress. Nesta página (Documentação) você encontrará todas as informações necessárias para começar a trabalhar com o Playground.


<!--
:::info
This practice also helps the maintenance team identify outdated translations. When the original English content is updated, we can search the codebase for the old text (now in comments) and flag the corresponding translation for review.
:::
-->

:::info
Esta prática também ajuda a equipe de manutenção a identificar traduções desatualizadas. Quando o conteúdo original em inglês é atualizado, podemos pesquisar no código base o texto antigo (agora em comentários) e sinalizar a tradução correspondente para revisão.
:::

<!--
To find a reviewer fluent in the language of your PR, you can post a request on the [Make WordPress Polyglots blog](https://make.wordpress.org/polyglots/). Be sure to include the locale tag (e.g., #ja for Japanese) to notify the appropriate General Translation Editors (GTEs).
-->

Para encontrar um revisor fluente no idioma do seu PR, você pode postar uma solicitação no [blog Make WordPress Polyglots](https://make.wordpress.org/polyglots/). Certifique-se de incluir a tag de localidade (por exemplo, #pt-BR para Português Brasileiro) para notificar os Editores Gerais de Tradução (GTEs) apropriados.

<!--
When the PR is merged, the translated version of that page should appear under `https://wordpress.github.io/wordpress-playground/{%LANGUAGE%}`, if you are contributing for the first time request your [Contributor Badge](/contributing/contributor-badge).
-->

Quando o PR for mesclado, a versão traduzida dessa página deve aparecer em `https://wordpress.github.io/wordpress-playground/{%LANGUAGE%}`, se você está contribuindo pela primeira vez, solicite seu [Emblema de Contribuidor](/contributing/contributor-badge).