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.

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

docs: update authentication information #23727

Merged
merged 2 commits into from
Jan 4, 2024
Merged

docs: update authentication information #23727

merged 2 commits into from
Jan 4, 2024

Conversation

piaxc
Copy link
Contributor

@piaxc piaxc commented Jan 3, 2024

Changes as per design doc previously provided to dazuma@.

b/266978558

piaxc added 2 commits January 3, 2024 13:44
This information is redundant and out of date. The Readme file contains authentication information as does the library-specific authentication files.
@SandeepTuniki
Copy link
Contributor

I'll let @dazuma review this, since it presumably had a background discussion I'm not aware of.

General comment though - I find AUTHENTICATION.md doc to be valuable. It serves as a good checklist for Ruby developers getting started. I use it regularly to remind myself of the auth steps. So I'd advise keeping this file.

@SandeepTuniki SandeepTuniki requested a review from dazuma January 4, 2024 06:41
@dazuma
Copy link
Member

dazuma commented Jan 4, 2024

The toplevel AUTHENTICATION.md content is basically duplicated in the AUTHENTICATION.md documentation for each individual library. We're deleting the toplevel file because it is redundant, and a bit out of date as we're updating the generated library files (see googleapis/gapic-generator-ruby#1022). We also prefer that users find their documentation through official channels (e.g. cloud.google.com or the library reference documentation on that site or on rubydoc.info) rather than from the github repository.

@dazuma dazuma merged commit 1396287 into googleapis:main Jan 4, 2024
13 checks passed
@yoshi-approver yoshi-approver added the release-please:force-run To run release-please label Jan 5, 2024
@release-please release-please bot removed the release-please:force-run To run release-please label Jan 5, 2024
@yoshi-approver yoshi-approver added the release-please:force-run To run release-please label Jan 5, 2024
@release-please release-please bot removed the release-please:force-run To run release-please label Jan 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants