GoogleCloudPlatform / GoogleCloudPlatform/cloud-sql-proxy

Align README and Proxy help message documentation

Aperta
#2,064 0 commenti 1 reazione 1 assegnatario Assegnata a @hessjcg Vedi su GitHub
priority: p2 type: cleanup
Lingua principale
Go
Stelle
1.4k
Fork
352
Merge medio
14h 54m
PR unite (30g)
5

Descrizione

This bug is to track adding the details of the Proxy help message to the README documentation and align on a process for documenting new flags moving forward.

Currently when we add a new flag/feature we prioritize adding it to the Proxy's help command https://github.com/GoogleCloudPlatform/cloud-sql-proxy/blob/main/cmd/root.go#L112

However, ideally we have the README and help message provide the same information so that users can find the relevant info no matter where they look.

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.