cloudnative-pg / cloudnative-pg/plugin-barman-cloud
incomplete API Reference
- 主要言語
- Go
- スター
- 191
- フォーク
- 72
- 平均マージ
- 2日 21時間
- マージ済み PR(30日)
- 21
説明
[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.
コントリビューションガイド
調査の方向性
v0.9.0 の ObjectStoreSpec API リファレンスから始め、その `configuration` フィールドを、リンクされている Go 構造体 BarmanObjectStoreConfiguration と比較します。そのリファレンスのドキュメントソースを見つけ、必須フィールドの明確な説明を追加します。生成された API リファレンスが、読者に Go コードの確認を求めることなくそのフィールドを説明できれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- go
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 58/100