cloudnative-pg / cloudnative-pg/plugin-barman-cloud
incomplete API Reference
- Ngôn ngữ chính
- Go
- Star
- 191
- Fork
- 72
- Merge trung bình
- 1 ngày 16 giờ
- Pull request đã merge (30 ngày)
- 18
Mô tả
[The API reference for `ObjectStoreSpec`](https://cloudnative-pg.io/plugin-barman-cloud/docs/plugin-barman-cloud.v1/#objectstorespec) as of v0.9.0 describes the rather important `configuration` field, but instead of referencing a clear description for that field references to the matching [some Go struct](https://pkg.go.dev/github.com/cloudnative-pg/barman-cloud/pkg/api#BarmanObjectStoreConfiguration), which is much harder to read - especially for people not familiar with Go.
Since this is a required part of the configuration, I guess it would be very helpful to have a clear description for this field, like the rest of the API reference.
Hướng dẫn đóng góp
Hướng nghiên cứu
Bắt đầu với tài liệu tham chiếu API của ObjectStoreSpec cho v0.9.0 và so sánh trường `configuration` của nó với struct Go được liên kết, BarmanObjectStoreConfiguration. Tìm nguồn tài liệu cho phần tham chiếu đó và thêm mô tả rõ ràng về trường bắt buộc; được xem là hoàn thành khi tài liệu tham chiếu API được tạo ra giải thích trường này mà không yêu cầu người đọc phải kiểm tra mã Go.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- go
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức phù hợp với người mới
- 58/100