Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Align README and Proxy help message documentation #2064

Open
jackwotherspoon opened this issue Dec 11, 2023 · 0 comments
Open

Align README and Proxy help message documentation #2064

jackwotherspoon opened this issue Dec 11, 2023 · 0 comments
Assignees
@jackwotherspoon
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: cleanup An internal cleanup or hygiene concern.

Comments

@jackwotherspoon
Copy link
Collaborator

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.
@jackwotherspoon jackwotherspoon added priority: p2 Moderately-important priority. Fix may not be included in next release. type: cleanup An internal cleanup or hygiene concern. labels Dec 11, 2023
@enocom enocom assigned jackwotherspoon and unassigned enocom May 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jackwotherspoon jackwotherspoon

Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: cleanup An internal cleanup or hygiene concern.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@enocom @jackwotherspoon