Pular para o conteúdo principal

Contribuições para a documentação

O site de documentação do WordPress Playground é mantido por voluntários como você, que adorariam sua ajuda.

Todas as issues relacionadas à documentação são rotuladas como [Type] Documentation ou [Type] Developer Documentation no repositório WordPress/wordpress-playground. Navegue pela lista de issues abertas para encontrar uma na qual você gostaria de trabalhar. Alternativamente, se você acredita que algo está faltando na documentação atual, abra uma issue para discutir sua sugestão.

Como posso contribuir?​

Você pode contribuir abrindo uma issue no repositório do projeto e descrevendo o que você gostaria de adicionar ou alterar.

Se você se sentir à vontade, escreva o conteúdo na descrição da issue, e os contribuidores do projeto cuidarão do resto.

Fazer fork do repositório, editar arquivos localmente e abrir Pull Requests​

Se você está familiarizado com markdown, pode fazer um fork do repositório wordpress-playground e propor alterações e novas páginas de documentação enviando um Pull Request.

O processo de criação de uma branch para abrir novos PRs com páginas traduzidas no repositório WordPress/wordpress-playground é o mesmo que contribuir para outros repositórios do WordPress, como o gutenberg: https://developer.wordpress.org/block-editor/contributors/code/git-workflow/

Os arquivos de documentação (arquivos .md) são armazenados no repositório GitHub do Playground, em /packages/docs/site/docs para versão em inglês e /packages/docs/site/i18n para outros idiomas.

Editar no navegador​

Se estiver logado no GitHub, você também pode editar arquivos existentes (ou adicionar novos) e enviar um PR diretamente da interface do GitHub:

  1. Encontre a página que você gostaria de editar ou o diretório do capítulo ao qual você gostaria de adicionar uma nova página.
  2. Clique no botão Add Files para adicionar um novo arquivo, ou clique em um arquivo existente e depois no ícone de lápis para editá-lo.
  3. O GitHub solicitará que você faça um fork do repositório e crie uma nova branch com suas alterações.
  4. Um editor será aberto onde você pode fazer as alterações.
  5. Quando terminar, clique no botão Commit Changes e envie um Pull Request.

É isso! Você acabou de contribuir para a documentação do WordPress Playground.

Esta abordagem significa que você não precisa clonar o repositório, configurar um ambiente de desenvolvimento local ou executar nenhum comando.

A desvantagem é que você não poderá visualizar suas alterações. Continue lendo para aprender como revisar suas alterações antes de enviar um Pull Request.

Pré-visualização local​

Clone o repositório e navegue para o diretório em seu dispositivo. Agora execute os seguintes comandos:

npm install
npm run build:docs
npm run dev:docs

O site da documentação abrirá em uma nova aba do navegador e será atualizado automaticamente a cada alteração. Continue a editar o arquivo relevante em seu editor de código e teste as alterações em tempo real.