cloudnative-pg / cloudnative-pg/plugin-barman-cloud

incomplete API Reference

Ouverte
#670 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
documentation
Langage dominant
Go
Étoiles
191
Forks
72
Merge moyen
2 j 21 h
PR mergées (30 j)
21

Description

[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.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par la référence de l’API de ObjectStoreSpec pour v0.9.0 et comparez son champ `configuration` avec la structure Go liée, BarmanObjectStoreConfiguration. Trouvez la source de documentation de cette référence et ajoutez une description claire du champ requis ; le travail est terminé lorsque la référence de l’API générée explique le champ sans obliger les lecteurs à consulter le code Go.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
go
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
58/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.