Contribuye con la documentación de Bazel

Informa un problema Ver código fuente

Gracias por colaborar con la documentación de Bazel. Existen varias formas de ayudar a crear mejores documentos para nuestra comunidad.

Tipos de documentación

Este sitio incluye algunos tipos de contenido.

  • Documentación narrativa, escrita por ingenieros y escritores técnicos La mayor parte de este sitio es documentación narrativa que cubre guías conceptuales y basadas en tareas.
  • Documentación de referencia, que se genera desde los comentarios de código. No puedes realizar cambios en las páginas del documento de referencia directamente, pero debes cambiar su fuente.

Infraestructura de documentación

La documentación de Bazel se entrega desde Google y los archivos de origen se duplican en el repositorio de GitHub de Bazel. Puedes realizar cambios en los archivos fuente en GitHub. Si se aprueba, puedes combinar los cambios y un encargado de mantenimiento de Bazel actualizará la fuente del sitio web para publicar tus actualizaciones.

Cambios pequeños

Puedes abordar cambios pequeños, como corregir errores tipográficos, de varias maneras.

  • Solicitud de extracción. Puedes crear una solicitud de extracción en GitHub con el editor basado en la Web o en una rama.
  • Error. Puedes informar un error con los detalles y los cambios sugeridos, y los propietarios de la documentación de Bazel harán la actualización.

Cambios importantes

Si deseas realizar cambios sustanciales en la documentación existente o proponer documentación nueva, puedes crear una solicitud de extracción o comenzar con un documento de Google y comunicarte con los propietarios de Bazel para que colaboren.