cloudnative-pg / cloudnative-pg/plugin-barman-cloud
incomplete API Reference
- Lenguaje dominante
- Go
- Estrellas
- 191
- Forks
- 72
- Merge medio
- 2 d 21 h
- PR fusionados (30 d)
- 21
Descripción
[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.
Guía de contribución
Línea de trabajo
Comienza con la referencia de la API de ObjectStoreSpec para v0.9.0 y compara su campo `configuration` con la estructura de Go vinculada, BarmanObjectStoreConfiguration. Encuentra la fuente de documentación de esa referencia y añade una descripción clara del campo requerido; se considera terminado cuando la referencia de la API generada explica el campo sin que los lectores tengan que inspeccionar el código Go.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- go
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bien especificado
- Aptitud para principiantes
- 58/100