Đóng góp cho tài liệu về Bazel

Báo cáo sự cố Xem nguồn

Cảm ơn bạn đã đóng góp cho tài liệu của Bazel! Có một số cách để giúp tạo tài liệu tốt hơn cho cộng đồng.

Loại tài liệu

Trang web này bao gồm một vài loại nội dung.

  • Tài liệu tường thuật, do các tác giả và kỹ sư kỹ thuật viết. Phần lớn nội dung trên trang web này là tài liệu tường thuật, trong đó hướng dẫn về các khái niệm cũng như hướng dẫn dựa trên nhiệm vụ.
  • Tài liệu tham khảo, là tài liệu được tạo từ các chú thích mã. Bạn không thể thay đổi trực tiếp các trang tài liệu tham khảo mà cần thay đổi nguồn của các trang đó.

Cơ sở hạ tầng tài liệu

Tài liệu của Bazel được phân phát từ Google và các tệp nguồn sẽ được phản chiếu trong kho lưu trữ GitHub của Bazel. Bạn có thể thay đổi các tệp nguồn trong GitHub. Nếu được chấp thuận, bạn có thể hợp nhất các thay đổi và một trình bảo trì Bazel sẽ cập nhật nguồn trang web để phát hành các bản cập nhật.

Thay đổi nhỏ

Bạn có thể xử lý những thay đổi nhỏ (chẳng hạn như sửa lỗi hoặc lỗi chính tả) theo một số cách.

  • Yêu cầu kéo. Bạn có thể tạo yêu cầu để lấy dữ liệu trong GitHub bằng trình chỉnh sửa dựa trên nền tảng web hoặc trên một nhánh.
  • Lỗi. Bạn có thể gửi lỗi cùng với thông tin chi tiết và các thay đổi được đề xuất, đồng thời chủ sở hữu tài liệu Bazel sẽ thực hiện cập nhật.

Thay đổi lớn

Nếu muốn thay đổi đáng kể tài liệu hiện có hoặc đề xuất tài liệu mới, bạn có thể tạo yêu cầu lấy dữ liệu hoặc bắt đầu bằng một tài liệu của Google và liên hệ với Chủ sở hữu Bazel để cộng tác.