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

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

Closed
macvean opened this issue Jul 8, 2015 · 7 comments · Fixed by #734
Closed

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

macvean opened this issue Jul 8, 2015 · 7 comments · Fixed by #734
Assignees

Comments

@macvean
Copy link

macvean commented Jul 8, 2015

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.

@stephenplusplus
Copy link
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.

@stephenplusplus stephenplusplus self-assigned this Jul 8, 2015
@jgeewax
Copy link
Contributor

jgeewax commented Jul 9, 2015

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

@stephenplusplus
Copy link
Contributor

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

@jgeewax
Copy link
Contributor

jgeewax commented Jul 9, 2015 via email

@stephenplusplus
Copy link
Contributor

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

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

@jgeewax
Copy link
Contributor

jgeewax commented Jul 9, 2015 via email

@stephenplusplus
Copy link
Contributor

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

sofisl pushed a commit that referenced this issue Nov 17, 2022
Source-Link: googleapis/googleapis@68ad73b
Source-Link: googleapis/googleapis-gen@a581672
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYTU4MTY3MjA2MWI5NDgxYzAxOTJkZTAzYmJmYTM0NjRlMDIzMzgxMSJ9
See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md
Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
sofisl pushed a commit that referenced this issue Jan 24, 2023
Common protos do not belong here, they are a part of google-gax.
sofisl pushed a commit that referenced this issue Jan 25, 2023
Common protos do not belong here, they are a part of google-gax.
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 a pull request may close this issue.

3 participants