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

docs: Add Cobra docs generator and CI #730

Merged
merged 4 commits into from
Dec 4, 2024
Merged

docs: Add Cobra docs generator and CI #730

merged 4 commits into from
Dec 4, 2024

Conversation

rhatgadkar-goog
Copy link
Contributor

This is similar to GoogleCloudPlatform/cloud-sql-proxy#2336, except for AlloyDB AuthProxy.

@rhatgadkar-goog
docs: Add Cobra docs generator and CI
7168f73 
This is similar to
GoogleCloudPlatform/cloud-sql-proxy#2336, except
for AlloyDB AuthProxy.
@rhatgadkar-goog rhatgadkar-goog requested a review from a team as a code owner December 2, 2024 23:51
@rhatgadkar-goog rhatgadkar-goog linked an issue Dec 2, 2024 that may be closed by this pull request
Add --help message documentation to README #709
Closed
@rhatgadkar-goog rhatgadkar-goog mentioned this pull request Dec 3, 2024
Merged
enocom
enocom requested changes Dec 3, 2024
View reviewed changes
Copy link
Member

@enocom enocom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding a link in the README would be good too:

"See the full Proxy documentation [here]" or something like that close to the usage section.

.github/workflows/docs.yml Outdated Show resolved Hide resolved
cmd/gendocs/gen_alloydb-proxy_docs.go Outdated Show resolved Hide resolved
cmd/gendocs/gen_alloydb-proxy_docs.go Outdated Show resolved Hide resolved
@rhatgadkar-goog
Copy link
Contributor Author

Adding a link in the README would be good too:

"See the full Proxy documentation [here]" or something like that close to the usage section.

Done. I've added it in my latest commit

enocom
enocom approved these changes Dec 4, 2024
View reviewed changes
Copy link
Member

@enocom enocom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks.

@rhatgadkar-goog rhatgadkar-goog merged commit 9c7b214 into main Dec 4, 2024
16 checks passed
@rhatgadkar-goog rhatgadkar-goog deleted the 709-add-help-message-documentation-to-readme branch December 4, 2024 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@enocom enocom enocom approved these changes

Assignees

@enocom enocom

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add --help message documentation to README
2 participants
@rhatgadkar-goog @enocom