Skip to content

docs: No mention of auth on the docs #182

Description

@rakyll

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

Activity

  1. ryanseys commented on Sep 5, 2014

    @ryanseys
    Contributor

    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.

  2. ryanseys commented on Sep 5, 2014

    @ryanseys
    Contributor

    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

  3. stephenplusplus commented on Sep 29, 2014

    @stephenplusplus
    Contributor

    @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?

  4. stephenplusplus commented on Oct 13, 2014

    @stephenplusplus
    Contributor

    @silvolu what do you think? Do we have this covered or can we do better?

  5. ryanseys commented on Nov 2, 2014

    @ryanseys
    Contributor

    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.

  6. stephenplusplus commented on Nov 17, 2014

    @stephenplusplus
    Contributor

    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

  7. stephenplusplus commented on Dec 22, 2014

    @stephenplusplus
    Contributor

    Added: #326

  8. added this to the Core Stable milestone on Feb 2, 2015
  9. 51 remaining items

  10. added a commit that references this issue on Feb 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

🚨This issue needs some love.triage meI really want to be triaged.

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions