Comece a contribuir para a documentação do PowerShell

Este artigo é uma visão geral de como começar como um colaborador para a documentação do PowerShell.

Estrutura PowerShell-Docs

Há três categorias de conteúdo no PowerShell-Docs repositório:

• Conteúdo de referência
• conteúdo conceptual
• Metadados e arquivos de configuração

Conteúdo de referência

O conteúdo de referência é a referência de cmdlet do PowerShell para os cmdlets fornecidos no PowerShell. O cmdlet referência é coletado em pastas versionadas (como 5.1, 7.4, 7.5 e 7.6), que contêm a referência para os módulos fornecidos com o PowerShell. Esse conteúdo também é usado para criar as informações de ajuda exibidas pelo cmdlet Get-Help.

Conteúdo conceptual

A documentação conceitual não está organizada por versão. Todos os artigos são exibidos para cada versão do PowerShell.

Observação

Sempre que um artigo conceitual é adicionado, removido ou renomeado, o sumário deve ser atualizado. Todos os arquivos excluídos ou renomeados devem ser redirecionados.

Arquivos de metadados

Este projeto contém vários tipos de arquivos de metadados. Os arquivos de metadados controlam o comportamento de nossas ferramentas de construção e do sistema de publicação. Somente mantenedores PowerShell-Docs e contribuidores aprovados têm permissão para alterar esses arquivos. Se você acha que um arquivo meta deve ser alterado, abra um problema para discutir as alterações necessárias.

Meta files na raiz do repositório

• .* - arquivos de configuração na raiz do repositório
• *.md - Documentação do projeto na raiz do repositório
• *.yml - Documentação do projeto na raiz do repositório
• .devcontainer/* - arquivos de configuração de "devcontainer"
• .github/**/* - Modelos, ações e outros arquivos meta do GitHub
• .vscode/**/* - Configurações de extensão VS Code
• assets/* - contém ficheiros descarregáveis ligados na documentação
• redir/* - contém ficheiros de mapeamento de redirecionamento
• tests/* - ferramentas de teste usadas pelo sistema de compilação
• tools/* - outras ferramentas utilizadas pelo sistema de compilação

Meta files no conjunto de documentação

• reference/**/*.json - arquivos de configuração de docset
• reference/**/*.yml - TOC e outros arquivos de conteúdo estruturado
• reference/bread/* - configuração de navegação breadcrumb
• reference/includes/* - inclusão de arquivos em markdown
• reference/mapping/* - configuração de mapeamento de versão
• reference/**/media/** - arquivos de imagem usados na documentação
• reference/module/* - Configuração da página do navegador do módulo

Criação de novos artigos

Um tópico do GitHub deve ser criado para qualquer novo documento que se pretenda contribuir. Verifique se há problemas existentes para garantir que você não está duplicando esforços. As questões atribuídas são consideradas como estando na categoria in progress. Se desejar colaborar em um problema, entre em contato com a pessoa designada para o problema.

Semelhante ao processo de RFC do PowerShell , crie um problema antes de escrever o conteúdo. O problema garante que você não perca tempo e esforço com o trabalho que é rejeitado pela equipe PowerShell-Docs. O problema nos permite consultá-lo sobre o escopo do conteúdo e onde ele se encaixa na documentação do PowerShell. Todos os artigos devem ser incluídos no Índice (TOC). A localização proposta do TOC deve ser incluída na discussão da questão.

Observação

O sistema de publicação gera automaticamente o sumário para conteúdo de referência. Não é necessário atualizar a Tabela de Conteúdos.

Atualização de artigos existentes

Quando aplicável, os artigos de referência do cmdlet são duplicados em todas as versões do PowerShell mantidas neste repositório. Ao relatar um problema sobre uma referência de cmdlet ou um artigo About_, liste as versões do artigo que têm o problema.

Aplique a alteração apropriada a cada versão do arquivo.

Conteúdo localizado

A documentação do PowerShell é escrita em inglês e traduzida para outros 17 idiomas. O conteúdo em inglês é armazenado no repositório GitHub chamado MicrosoftDocs/PowerShell-Docs. Os problemas encontrados no conteúdo traduzido devem ser enviados para este repositório.

Todas as traduções começam primeiro a partir do conteúdo em inglês. Usamos tradução humana e automática.

Método de tradução	Idiomas
Tradução humana	de-DE, es-ES, fr-FR, it-IT, ja-JP, ko-KR, pt-BR, ru-RU, zh-CN, zh-TW
Tradução automática	cs-CZ, hu-HU, nl-NL, pl-PL, pt-PT, sv-SE, tr-TR

O conteúdo traduzido por tradução automática pode nem sempre resultar em escolhas de palavras e gramática corretas. Se você encontrar um erro na tradução para qualquer idioma, em vez de nos detalhes técnicos do artigo, abra um problema explicando por que você acha que a tradução está errada.

Alguns problemas de tradução podem ser corrigidos alterando os arquivos de origem em inglês. No entanto, alguns problemas podem exigir atualizações do nosso sistema interno de tradução. Para esses casos, devemos enviar o problema à nossa equipe interna de localização para revisão e resposta.

Próximos passos

Há duas maneiras comuns de enviar alterações no GitHub. Ambos os métodos são descritos no Guia do Colaborador central:

1. Pode editar rapidamente documentos existentes na interface web do GitHub.
2. Use o de fluxo de trabalho completo do GitHub para adicionar novos artigos, atualizar vários arquivos ou outras alterações grandes.

Antes de iniciar qualquer alteração, deve-se criar um fork do repositório PowerShell-Docs. As alterações devem ser feitas num ramo de trabalho na sua cópia do PowerShell-Docs. Se estiver a usar o método de edição rápida no GitHub, esses passos são tratados automaticamente por si. Se estiveres a usar o fluxo de trabalho completo do GitHub , deves estar preparado para trabalhar localmente.

Ambos os métodos terminam com a criação de um Pull Request (PR). Para obter mais informações e práticas recomendadas, consulte Enviando uma solicitação pull.