Skip to content

readme: link to auth info above samples#2543

Merged
stephenplusplus merged 1 commit intogoogleapis:masterfrom
stephenplusplus:spp--2534
Aug 21, 2017
Merged

readme: link to auth info above samples#2543
stephenplusplus merged 1 commit intogoogleapis:masterfrom
stephenplusplus:spp--2534

Conversation

@stephenplusplus
Copy link
Copy Markdown
Contributor

Fixes #2534

cc @gauntface

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Aug 18, 2017
@coveralls
Copy link
Copy Markdown

Coverage Status

Coverage remained the same at 100.0% when pulling 7f30115 on stephenplusplus:spp--2534 into 288ff5a on GoogleCloudPlatform:master.

@gauntface
Copy link
Copy Markdown

gauntface commented Aug 21, 2017

What I ended up doing was doing a search for keyFilename throughout the readme and only saw examples using it. Authentication makes total sense but I didn't see it because I expected to see a well of text along the lines of:

To use our SDK you need to authenticate using a service account. The key you'll download from the service account panel is then passed in via the keyFilename parameter.

@stephenplusplus
Copy link
Copy Markdown
Contributor Author

I think the Authentication section is pretty thorough already because it has to cover multiple forms of authentication (application default, service account JSON/PEM, credentials object), as well as other steps, like billing & enabling APIs. To add more to it would bloat it out even more.

I'll merge this as-is for now, since this should at least be an improvement. A PR would be awesome though, if you can think of a way to make this even better.

@stephenplusplus stephenplusplus merged commit f243e26 into googleapis:master Aug 21, 2017
thiyaguk09 pushed a commit to thiyaguk09/google-cloud-node-fork that referenced this pull request Mar 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants