Contribuir com a documentação do Bazel

Informar um problema Mostrar fonte Por noite · 7,4 do Google. 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Agradecemos por contribuir com a documentação do Bazel. Existem algumas maneiras de criar documentos melhores para nossa comunidade.

Tipos de documentação

Este site inclui alguns tipos de conteúdo.

  • Documentação narrativa, que é escrita por redatores técnicos e engenheiros. A maior parte do site é uma documentação narrativa que cobre guias conceituais e baseados em tarefas.
  • Documentação de referência, que é gerada a partir de comentários de código. Você não pode fazer alterações diretamente nas páginas do documento de referência, mas precisa para alterar a origem.

Infraestrutura de documentação

A documentação do Bazel é disponibilizada pelo Google, e os arquivos de origem são espelhados Repositório do GitHub do Bazel. Você pode fazer mudanças nos arquivos de origem no GitHub. Se aprovada, você poderá mesclar as alterações, e um administrador do Bazel atualizará o fonte do site para publicar suas atualizações.

Pequenas mudanças

Você pode abordar pequenas mudanças, como corrigir erros ou erros de digitação, em algumas de várias formas.

  • Solicitação de envio. É possível criar uma solicitação de envio no GitHub com o editor baseado na Web ou em uma ramificação.
  • Bug. Você pode informar um bug com detalhes e mudanças sugeridas e o Bazel os proprietários da documentação farão a atualização.

Mudanças grandes

Se você quiser fazer mudanças substanciais na documentação existente ou propor documentação, será possível criar uma solicitação de envio ou começar com uma solicitação documento e entre em contato com os proprietários do Bazel para colaborar.