GoogleCloudPlatform / GoogleCloudPlatform/cloud-sql-proxy
Align README and Proxy help message documentation
Abierto
priority: p2
type: cleanup
- Lenguaje dominante
- Go
- Estrellas
- 1.4k
- Forks
- 352
- Merge medio
- 14 h 54 min
- PR fusionados (30 d)
- 5
Descripción
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.
Guía de contribución
Evaluación
Este issue todavía no se ha evaluado.