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 escritores e engenheiros técnicos. A maior parte deste site é uma documentação narrativa que abrange guias conceituais e baseados em tarefas.
- Documentação de referência, que é gerada a partir de comentários do código. Não é possível fazer alterações diretamente nas páginas do documento de referência, mas você precisa alterar a origem delas.
Infraestrutura de documentação
A documentação do Bazel é disponibilizada pelo Google e os arquivos de origem são espelhados no repositório do Bazel do GitHub. É possível fazer alterações nos arquivos de origem no GitHub. Se for aprovado, você poderá mesclar as alterações. Um mantenedor do Bazel atualizará o código-fonte do site para publicar suas atualizações.
Pequenas alterações
Há várias maneiras de abordar pequenas mudanças, como corrigir erros ou erros de digitação.
- 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. Registre um bug com detalhes e alterações sugeridas. Os proprietários da documentação do Bazel farão a atualização.
Grandes mudanças
Se você quiser fazer alterações substanciais na documentação existente ou propor uma nova documentação, crie uma solicitação de envio ou comece com um documento do Google e entre em contato com os proprietários do Bazel para colaborar.