Skip to content

Clarify API Enablement instructions in the Authorization section of readme.md #710

Description

@macvean

In the Authorization -> Elsewhere section of the readme, readers are instructed to:

Navigate to APIs & auth > APIs section and turn on the following APIs (you may need to enable billing in order to use these services):

  1. Google Cloud Datastore API
  2. Google Cloud Storage
  3. Google Cloud Storage JSON API

Given this description is API agnostic, it is slightly confusing why these three APIs are chose. I would recommend either:

  1. Adding clear instruction to 'Enable the APIs you intend to use, for example, for Cloud Storage you will need to enable Cloud Storage API and Cloud Storage JSON API"

or

  1. Including all APIs supported by gcloud-node, with a note that if they do not intend to use all services, you only need to enable those you do need.

As a small nit, lets use the language 'enable' and 'disable' for consistency with the experience when they get to the GUI.

Activity

  1. stephenplusplus commented on Jul 8, 2015

    @stephenplusplus
    Contributor

    Great ideas! I think it would be best to show the services supported by this library and the matching APIs that must be enabled. Along with that, we can leave a reminder to only enable the ones you need.

  2. jgeewax commented on Jul 9, 2015

    @jgeewax
    Contributor

    This is also something that would benefit all the gcloud-* projects...

    Maybe it's time to create gcloud-common, push some Markdown and screenshots to that library, and submodule them in...?

  3. stephenplusplus commented on Jul 9, 2015

    @stephenplusplus
    Contributor

    Sounds good to me; are we renaming meta or starting new?

  4. jgeewax commented on Jul 9, 2015

    @jgeewax
    Contributor
  5. stephenplusplus commented on Jul 9, 2015

    @stephenplusplus
    Contributor

    Private roadmap stuff does come up now and then, so that makes sense.

    Opened https://github.com/GoogleCloudPlatform/gcloud-common

  6. jgeewax commented on Jul 9, 2015

    @jgeewax
    Contributor
  7. stephenplusplus commented on Jul 22, 2015

    @stephenplusplus
    Contributor

    This was fixed over in gcloud-common, but will wait for #734 to merge before calling this resolved.

  8. added a commit that references this issue on Nov 10, 2022
  9. 11 remaining items

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

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions