Repository navigation
docs: No mention of auth on the docs #182
Description
Activity
Users are likely to skip README
I never skip the README, especially when perusing through many repos looking for a solution to a problem.
I'm all for the README having a couple samples. Maybe not a full comprehensive guide but give them a taste for what the library can do instead of pushing them off to another site.
I don't follow the following post to a T, but it's kinda be inherently ingrained in the users of GitHub considering the README is the front face of every repository page here: http://tom.preston-werner.com/2010/08/23/readme-driven-development.html
@rakyll the entry page of the docs (http://googlecloudplatform.github.io/gcloud-node/#/docs/v0.7.1) is pretty good at explaining first steps. Every subsequent page has a helpful "Getting Started with gcloud" pulldown as well. Does this cover your initial concerns?
@silvolu what do you think? Do we have this covered or can we do better?
Auth is as simple as providing a keyFilename pointing to their key file. This is covered on the front page at http://googlecloudplatform.github.io/gcloud-node and pretty much every example getting started with using an API. @rakyll If you would like a simpler README, please open a separate issue regarding that. Closing this as RESOLVED.
Reopening: #303 (comment)
I was thinking: maybe we could add an Authentication.md containing a troubleshooting guide, and add a link to that from the error?
- @silvolu
Added: #326
51 remaining items
- added a commit that references this issue
on Feb 17, 2026 - added a commit that references this issue
on Feb 24, 2026 - added a commit that references this issue
on Mar 5, 2026 - added a commit that references this issue
on Mar 5, 2026 - added a commit that references this issue
on Mar 5, 2026 - added a commit that references this issue
on Mar 11, 2026 - added a commit that references this issue
on Mar 12, 2026 - added a commit that references this issue
on Mar 12, 2026 - added a commit that references this issue
on Mar 27, 2026 - added a commit that references this issue
on Mar 27, 2026 - added a commit that references this issue
on May 5, 2026
Users are likely to skip README to read http://googlecloudplatform.github.io/gcloud-node
We should have a quickstart guide explaining the authorization and the first steps.
README should better only mention what this repo is and which APIs we support, then give a link to http://googlecloudplatform.github.io/gcloud-node