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.

Sign up for GitHub

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

Jump to bottom

Update storage README.md #1759

Closed
wants to merge 1 commit into from
Closed

Update storage README.md #1759

wants to merge 1 commit into from

Conversation

syndbg
Copy link

@syndbg syndbg commented Oct 31, 2016

Add missing option how to use the storage client with an API key.
Update button names to refer to the actual names in the UI.

@syndbg
Update storage README.md
b986f66 
Add missing option how to use the storage client with an API key.
Update button names to refer to the actual names in the UI.
@googlebot
Copy link

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed, please reply here (e.g. I signed it!) and we'll verify. Thanks.

  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If you signed the CLA as a corporation, please let us know the company's name.

@googlebot googlebot added the cla: no This human has *not* signed the Contributor License Agreement. label Oct 31, 2016
@syndbg
Copy link
Author

syndbg commented Oct 31, 2016

I signed it!

@googlebot
Copy link

CLAs look good, thanks!

@googlebot googlebot added cla: yes This human has signed the Contributor License Agreement. and removed cla: no This human has *not* signed the Contributor License Agreement. labels Oct 31, 2016
stephenplusplus
stephenplusplus suggested changes Oct 31, 2016
View reviewed changes
Copy link
Contributor

@stephenplusplus stephenplusplus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much for this! I believe we only support an API key for the Translate API, so it is likely misleading to suggest it's always an option.

Instead of making these changes only in packages/storage/README.md, it would be amazing if you did them all of the README files (packages/*/README.md) including the root readme (README.md).

packages/storage/README.md
* If you want to generate a new key for an existing service account, click on **Generate new JSON key** and download the JSON key file.
* If you want to use a new service account key, click on **Create credentials** and select **Service account key**. After the account key is created, you will be prompted to download the JSON key file that the library uses to authenticate your requests.
* If you want to generate a new service account key for an existing service account, click on **Generate new JSON key** and download the JSON key file.
* If you want to use a new API key, click on **Create credentials** and select **API key**. After the API key is created, you will see a newly opened modal with the API key in a field named **Your API key** that the library uses to authenticate your requests.

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

packages/storage/README.md

``` js
var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123'

var gcs = require('@google-cloud/storage')({
// 1. Specify projectId

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

@syndbg
Copy link
Author

syndbg commented Oct 31, 2016 

Thank you very much for this! I believe we only support an API key for the Translate API, so it is likely misleading to suggest it's always an option.

Instead of making these changes only in packages/storage/README.md, it would be amazing if you did them all of the README files (packages/*/README.md) including the root readme (README.md).

Sure. I can change them in this PR if you'd like.

@stephenplusplus stephenplusplus added docs api: storage Issues related to the Cloud Storage API. labels Nov 1, 2016
@stephenplusplus
Copy link
Contributor

Sure. I can change them in this PR if you'd like.

Please, that would be great!

@stephenplusplus stephenplusplus mentioned this pull request Nov 14, 2016
Merged
@stephenplusplus
Copy link
Contributor

Thanks again for this @syndbg, I've put this into a new PR to save you from more work. You've done enough!

New PR: #1791

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stephenplusplus stephenplusplus stephenplusplus requested changes

Assignees
No one assigned
Labels
api: storage Issues related to the Cloud Storage API. cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@syndbg @googlebot @stephenplusplus