Skip to content

Commit

Permalink
convert gcloud -> gcloud-node
Browse files Browse the repository at this point in the history
  • Loading branch information
stephenplusplus committed Jun 24, 2016
1 parent 896b0f4 commit 832c5a9
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 14 deletions.
6 changes: 3 additions & 3 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## How do I use `gcloud` with Google Compute Engine?
## How do I use `gcloud-node` with Google Compute Engine?

If you are running this client on Google Compute Engine, we handle authentication for you with no configuration. You just need to make sure that when you [set up the GCE instance][gce-how-to], you add the correct scopes for the APIs you want to access.

Expand All @@ -8,7 +8,7 @@ If you are running this client on Google Compute Engine, we handle authenticatio
If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account, please see our [Authentication][auth-guide] guide.


## How do I use `gcloud` with AWS Lambda?
## How do I use `gcloud-node` with AWS Lambda?

Our library uses some native libraries, which must be recompiled against the platform running your application. For AWS Lambda, we recommend using [lambda-packager](https://github.com/tomdale/lambda-packager) prior to deploying your code.

Expand All @@ -17,7 +17,7 @@ Reference Issues: [#1287](https://github.com/GoogleCloudPlatform/gcloud-node/iss

## Does this replace [Google Cloud Node.js Client][googleapis]?

Google Cloud Node.js Client is a client library for using the broad set of Google APIs. `gcloud` is built specifically for the Google Cloud Platform and is the recommended way to integrate Google Cloud APIs into your Node.js applications. If your application requires both Google Cloud Platform and other Google APIs, the 2 libraries may be used together.
Google Cloud Node.js Client is a client library for using the broad set of Google APIs. `gcloud-node` is built specifically for the Google Cloud Platform and is the recommended way to integrate Google Cloud APIs into your Node.js applications. If your application requires both Google Cloud Platform and other Google APIs, the 2 libraries may be used together.

[dev-console]: https://console.developers.google.com/project
[gce-how-to]: https://developers.google.com/compute/docs/authentication#using
Expand Down
14 changes: 7 additions & 7 deletions docs/home.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<section class="hero-banner">
<div class="container clearfix">
<div class="quote-box">
<h1>gcloud</h1>
<h1>gcloud-node</h1>
<p>Google Cloud Client Library for Node.js
- an idiomatic, intuitive, and natural way for Node.js developers to
integrate with Google Cloud Platform services, like Cloud Datastore
Expand Down Expand Up @@ -60,7 +60,7 @@ <h4 class="latest-release subtle" ng-if="home.latestRelease">
<div class="quote-box">
<h3 class="block-title">What is it?</h3>

<p><code>gcloud</code> is a client library for accessing Google
<p><code>gcloud-node</code> is a client library for accessing Google
Cloud Platform services that significantly reduces the boilerplate
code you have to write. The library provides high-level API
abstractions so they're easier to understand. It embraces
Expand All @@ -69,7 +69,7 @@ <h3 class="block-title">What is it?</h3>
All this means you spend more time creating code that matters
to you.</p>

<p><code>gcloud</code> is configured to access Google Cloud Platform
<p><code>gcloud-node</code> is configured to access Google Cloud Platform
services and authenticate (OAuth 2.0) automatically on your behalf.
With a one-line install and a private key, you are up and ready
to go. Better yet, if you are running on a Google Compute Engine
Expand Down Expand Up @@ -150,22 +150,22 @@ <h3 class="block-title">Examples</h3>
<div class="container clearfix">
<h3 class="block-title">FAQ</h3>

<h4>What is the relationship between the <code>gcloud</code> package
<h4>What is the relationship between the <code>gcloud-node</code> package
and the <code>gcloud</code> command-line tool?</h4>
<p>Both the <code>gcloud</code> command-line tool and
<code>gcloud</code> package are a part of the Google Cloud SDK: a collection
<code>gcloud-node</code> package are a part of the Google Cloud SDK: a collection
of tools and libraries that enable you to easily create and manage
resources on the Google Cloud Platform. The <code>gcloud</code> command-line
tool can be used to manage both your development workflow and your
Google Cloud Platform resources while the <code>gcloud</code> package is the
Google Cloud Client Library for Node.js.</p>

<h4>What is the relationship between <code>gcloud</code>
<h4>What is the relationship between <code>gcloud-node</code>
and the Google APIs Node.js Client?</h4>
<p>The <a href="https://github.com/google/google-api-nodejs-client">
Google APIs Node.js Client</a> is a client library for
using the broad set of Google APIs.
<code>gcloud</code> is built specifically for the Google Cloud Platform
<code>gcloud-node</code> is built specifically for the Google Cloud Platform
and is the recommended way to integrate Google Cloud APIs into your
Node.js applications. If your application requires both Google Cloud Platform and
other Google APIs, the 2 libraries may be used by your application.</p>
Expand Down
6 changes: 3 additions & 3 deletions docs/overview.html
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<p>
First, install <code>gcloud</code> with npm and require it into your project:
First, install <code>gcloud-node</code> with npm and require it into your project:
</p>
<div hljs>$ npm install --save gcloud</div>
<div hljs>var gcloud = require('gcloud');</div>
<p>
If you are running your app on Google Compute Engine, you won't need to worry about supplying connection configuration options to <code>gcloud</code>&mdash; we figure that out for you.
If you are running your app on Google Compute Engine, you won't need to worry about supplying connection configuration options to <code>gcloud-node</code> we figure that out for you.
</p>
<p>
However, if you're running your app elsewhere, you will need to provide project details to authenticate API requests.
Expand All @@ -19,5 +19,5 @@
keyFilename: '/path/to/keyfile.json'
});</div>
<p>
The full set of options which can be passed to gcloud and sub-modules are <a href="#/docs">outlined here</a>.
The full set of options which can be passed to gcloud-node and sub-modules are <a href="#/docs">outlined here</a>.
</p>
2 changes: 1 addition & 1 deletion docs/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## I'm using a key from the Developer's Console, but getting: `Your private key is in an unexpected format and cannot be used. Please try again with another private key.`

There are many types of keys that can be created through the Developer's Console. The one gcloud expects is one for a "Service account".
There are many types of keys that can be created through the Developer's Console. The one gcloud-node expects is one for a "Service account".

See "I'm not using Compute Engine. What do I need to do?" from the [FAQ](https://googlecloudplatform.github.io/gcloud-node/#/faq) for detailed steps on how to create and obtain a JSON key.

Expand Down

0 comments on commit 832c5a9

Please sign in to comment.