Cảm ơn bạn đã đóng góp tài liệu của Bazel! Có một vài cách để giúp tạo ra tài liệu tốt hơn cho cộng đồng của chúng ta.
Các loại tài liệu
Trang web này có một số loại nội dung.
- Tài liệu dạng tường thuật do các kỹ sư và nhà văn kỹ thuật viết. Hầu hết nội dung trên trang web này là tài liệu tường thuật bao gồm hướng dẫn dựa trên nhiệm vụ và khái niệm.
- Tài liệu tham khảo, là tài liệu được tạo từ các nhận xét trong mã. Bạn không thể trực tiếp thay đổi các trang tài liệu tham khảo, mà thay vào đó, bạn cần thay đổi nguồn của các trang đó.
Cơ sở hạ tầng của tài liệu
Tài liệu trong Bazel được phân phát từ Google và các tệp nguồn đượ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 phê duyệt, bạn có thể hợp nhất các thay đổi đó và một người duy trì Bazel sẽ cập nhật nguồn trang web để xuất bản các bản cập nhật của bạn.
Thay đổi nhỏ
Bạn có thể thực hiện một số 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 kéo trong GitHub bằng trình chỉnh sửa dựa trên web hoặc trên một nhánh.
- Lỗi. Bạn có thể gửi lỗi kèm theo thông tin chi tiết và nội dung thay đổi đề xuất. Chủ sở hữu tài liệu Bazel sẽ cập nhật nội dung đó.
Thay đổi lớn
Nếu bạn muốn thay đổi đáng kể tài liệu hoặc đề xuất hiện tại, tài liệu mới, bạn có thể tạo một yêu cầu lấy dữ liệu hoặc bắt đầu bằng một tài liệu và liên hệ với Bazel Owners để cộng tác.