Contribuir com a documentação do Bazel

Reportar um problema Ver a fonte Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

Agradecemos sua contribuição para a documentação do Bazel. Há algumas maneiras de ajudar a criar documentos melhores para nossa comunidade.

Tipos de documentação

Este site inclui alguns tipos de conteúdo.

  • Documentação narrativa, escrita por redatores técnicos e engenheiros. A maior parte deste site é documentação narrativa que abrange guias conceituais e baseados em tarefas.
  • Documentação de referência, que é a documentação gerada com base em comentários de código. Não é possível fazer mudanças diretamente nas páginas do documento de referência. Em vez disso, é necessário mudar a origem delas.

Infraestrutura de documentação

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

Pequenas mudanças

Você pode fazer pequenas mudanças, como corrigir erros ou erros de digitação, de algumas maneiras.

  • 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 registrar um bug com detalhes e mudanças sugeridas, e os proprietários da documentação do Bazel farão a atualização.

Grandes mudanças

Se você quiser fazer mudanças significativas na documentação atual ou propor uma nova, crie uma solicitação de pull ou comece com um documento do Google e entre em contato com os proprietários do Bazel para colaborar.