Skip to content

Commit

Permalink
docs: change Google Cloud to Cloud (#1995)
Browse files Browse the repository at this point in the history
  • Loading branch information
@callmehiphop @stephenplusplus
callmehiphop authored and stephenplusplus committed Mar 3, 2017
1 parent 0d89ab7 commit fdb06ea
Show file tree
Hide file tree
Showing 64 changed files with 241 additions and 241 deletions.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To run the system tests, first create and configure a project in the Google Deve
- **GCLOUD_TESTS_PROJECT_ID**: Developers Console project's ID (e.g. bamboo-shift-455)
- **GCLOUD_TESTS_KEY**: The path to the JSON key file.
- ***GCLOUD_TESTS_API_KEY*** (*optional*): An API key that can be used to test the Translate API.
- ***GCLOUD_TESTS_DNS_DOMAIN*** (*optional*): A domain you own managed by Google Cloud DNS (expected format: `'gcloud-node.com.'`).
- ***GCLOUD_TESTS_DNS_DOMAIN*** (*optional*): A domain you own managed by Cloud DNS (expected format: `'gcloud-node.com.'`).

Install the [gcloud command-line tool][gcloudcli] to your machine and use it to create the indexes used in the datastore system tests with indexes found in `system-test/data/index/yaml`:

Expand Down
232 changes: 116 additions & 116 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Google Cloud Node.js Client
# Cloud Node.js Client
> Node.js idiomatic client for [Google Cloud Platform](https://cloud.google.com/) services.
[![NPM Version](https://img.shields.io/npm/v/google-cloud.svg)](https://www.npmjs.org/package/google-cloud)
Expand All @@ -13,22 +13,22 @@
This client supports the following Google Cloud Platform services at a [Beta](#versioning) quality level:

* [Google BigQuery](#google-bigquery-beta) (Beta)
* [Google Cloud Datastore](#google-cloud-datastore-beta) (Beta)
* [Google Cloud Storage](#google-cloud-storage-beta) (Beta)
* [Cloud Datastore](#google-cloud-datastore-beta) (Beta)
* [Cloud Storage](#google-cloud-storage-beta) (Beta)
* [Google Stackdriver Logging](#google-stackdriver-logging-beta) (Beta)

This client supports the following Google Cloud Platform services at an [Alpha](#versioning) quality level:

* [Cloud Bigtable](#cloud-bigtable-alpha) (Alpha)
* [Cloud DNS](#cloud-dns-alpha) (Alpha)
* [Cloud Natural Language](#cloud-natural-language-alpha) (Alpha)
* [Cloud Pub/Sub](#cloud-pubsub-alpha) (Alpha)
* [Cloud Resource Manager](#cloud-resource-manager-alpha) (Alpha)
* [Cloud Spanner](#cloud-spanner-alpha) (Alpha)
* [Google Cloud Bigtable](#google-cloud-bigtable-alpha) (Alpha)
* [Google Cloud DNS](#google-cloud-dns-alpha) (Alpha)
* [Google Cloud Natural Language](#google-cloud-natural-language-alpha) (Alpha)
* [Google Cloud Pub/Sub](#google-cloud-pubsub-alpha) (Alpha)
* [Google Cloud Resource Manager](#google-cloud-resource-manager-alpha) (Alpha)
* [Google Cloud Speech](#google-cloud-speech-alpha) (Alpha)
* [Google Cloud Translation API](#google-cloud-translation-api-alpha) (Alpha)
* [Google Cloud Vision](#google-cloud-vision-alpha) (Alpha)
* [Google Compute Engine](#google-compute-engine-alpha) (Alpha)
* [Cloud Speech](#cloud-speech-alpha) (Alpha)
* [Cloud Translation API](#cloud-translation-api-alpha) (Alpha)
* [Cloud Vision](#cloud-vision-alpha) (Alpha)
* [Google Compute Engine](#compute-engine-alpha) (Alpha)
* [Google Prediction API](#google-prediction-api-alpha) (Alpha)
* [Google Stackdriver Monitoring](#google-stackdriver-monitoring-alpha) (Alpha)

Expand All @@ -55,7 +55,7 @@ $ npm install --save google-cloud

## Authentication

With `google-cloud` it's incredibly easy to get authenticated and start using Google's APIs. You can set your credentials on a global basis as well as on a per-API basis. See each individual API section below to see how you can auth on a per-API-basis. This is useful if you want to use different accounts for different Google Cloud services.
With `google-cloud` it's incredibly easy to get authenticated and start using Google's APIs. You can set your credentials on a global basis as well as on a per-API basis. See each individual API section below to see how you can auth on a per-API-basis. This is useful if you want to use different accounts for different Cloud services.

### On Google Cloud Platform

Expand Down Expand Up @@ -174,12 +174,12 @@ job.getQueryResults().on('data', function(row) {});
```


## Google Cloud Datastore (Beta)
## Cloud Datastore (Beta)

- [API Documentation][gcloud-datastore-docs]
- [Official Documentation][cloud-datastore-docs]

*Follow the [activation instructions][cloud-datastore-activation] to use the Google Cloud Datastore API with your project.*
*Follow the [activation instructions][cloud-datastore-activation] to use the Cloud Datastore API with your project.*

#### Using the all-in-one module

Expand Down Expand Up @@ -248,7 +248,7 @@ datastoreClient.save({
```


## Google Cloud Storage (Beta)
## Cloud Storage (Beta)

- [API Documentation][gcloud-storage-docs]
- [Official Documentation][cloud-storage-docs]
Expand Down Expand Up @@ -392,103 +392,12 @@ loggingClient.getEntries(function(err, entries) {
```


## Cloud Spanner (Alpha)

- [API Documentation][gcloud-spanner-docs]
- [Official Documentation][cloud-spanner-docs]

#### Using the all-in-one module

```
$ npm install --save google-cloud
```

```js
var gcloud = require('google-cloud');
var spanner = gcloud.spanner;
```

#### Using the Cloud Spanner API module

```
$ npm install --save @google-cloud/spanner
```

```js
var spanner = require('@google-cloud/spanner');
```

#### Preview

```js
// Authenticating on a per-API-basis. You don't need to do this if you auth on a
// global basis (see Authentication section above).

var spannerClient = spanner({
projectId: 'grape-spaceship-123',
keyFilename: '/path/to/keyfile.json'
});

var instance = spannerClient.instance('my-instance');
var database = instance.database('my-database');

// Create a table.
var schema =
'CREATE TABLE Singers (' +
' SingerId INT64 NOT NULL,' +
' FirstName STRING(1024),' +
' LastName STRING(1024),' +
' SingerInfo BYTES(MAX),' +
') PRIMARY KEY(SingerId)';

database.createTable(schema, function(err, table, operation) {
if (err) {
// Error handling omitted.
}

operation
.on('error', function(err) {})
.on('complete', function() {
// Table created successfully.
});
});

// Insert data into the table.
var table = database.table('Singers');

table.insert({
SingerId: 10,
FirstName: 'Eddie',
LastName: 'Wilson'
}, function(err) {
if (!err) {
// Row inserted successfully.
}
});

// Run a query as a readable object stream.
database.runStream('SELECT * FROM Singers')
.on('error', function(err) {})
.on('data', function(row) {
// row.toJSON() = {
// SingerId: 10,
// FirstName: 'Eddie',
// LastName: 'Wilson'
// }
}
})
.on('end', function() {
// All results retrieved.
});
```


## Google Cloud Bigtable (Alpha)
## Cloud Bigtable (Alpha)

- [API Documentation][gcloud-bigtable-docs]
- [Official Documentation][cloud-bigtable-docs]

*You may need to [create a cluster][cloud-bigtable-cluster] to use the Google Cloud Bigtable API with your project.*
*You may need to [create a cluster][cloud-bigtable-cluster] to use the Cloud Bigtable API with your project.*

#### Using the all-in-one module

Expand Down Expand Up @@ -554,7 +463,7 @@ row.save('follows:gwashington', 1, function(err) {
```


## Google Cloud DNS (Alpha)
## Cloud DNS (Alpha)

- [API Documentation][gcloud-dns-docs]
- [Official Documentation][cloud-dns-docs]
Expand Down Expand Up @@ -613,7 +522,7 @@ zone.export('/zonefile.zone', function(err) {});
```


## Google Cloud Natural Language (Alpha)
## Cloud Natural Language (Alpha)

- [API Documentation][gcloud-language-docs]
- [Official Documentation][cloud-language-docs]
Expand Down Expand Up @@ -695,7 +604,7 @@ document.annotate(function(err, annotations) {
```


## Google Cloud Pub/Sub (Alpha)
## Cloud Pub/Sub (Alpha)

- [API Documentation][gcloud-pubsub-docs]
- [Official Documentation][cloud-pubsub-docs]
Expand Down Expand Up @@ -753,7 +662,7 @@ topic.subscribe('subscription-name', function(err, subscription) {
```


## Google Cloud Resource Manager (Alpha)
## Cloud Resource Manager (Alpha)

- [API Documentation][gcloud-resource-docs]
- [Official Documentation][cloud-resource-docs]
Expand Down Expand Up @@ -806,7 +715,98 @@ project.getMetadata(function(err, metadata) {
```


## Google Cloud Speech (Alpha)
## Cloud Spanner (Alpha)

- [API Documentation][gcloud-spanner-docs]
- [Official Documentation][cloud-spanner-docs]

#### Using the all-in-one module

```
$ npm install --save google-cloud
```

```js
var gcloud = require('google-cloud');
var spanner = gcloud.spanner;
```

#### Using the Cloud Spanner API module

```
$ npm install --save @google-cloud/spanner
```

```js
var spanner = require('@google-cloud/spanner');
```

#### Preview

```js
// Authenticating on a per-API-basis. You don't need to do this if you auth on a
// global basis (see Authentication section above).

var spannerClient = spanner({
projectId: 'grape-spaceship-123',
keyFilename: '/path/to/keyfile.json'
});

var instance = spannerClient.instance('my-instance');
var database = instance.database('my-database');

// Create a table.
var schema =
'CREATE TABLE Singers (' +
' SingerId INT64 NOT NULL,' +
' FirstName STRING(1024),' +
' LastName STRING(1024),' +
' SingerInfo BYTES(MAX),' +
') PRIMARY KEY(SingerId)';

database.createTable(schema, function(err, table, operation) {
if (err) {
// Error handling omitted.
}

operation
.on('error', function(err) {})
.on('complete', function() {
// Table created successfully.
});
});

// Insert data into the table.
var table = database.table('Singers');

table.insert({
SingerId: 10,
FirstName: 'Eddie',
LastName: 'Wilson'
}, function(err) {
if (!err) {
// Row inserted successfully.
}
});

// Run a query as a readable object stream.
database.runStream('SELECT * FROM Singers')
.on('error', function(err) {})
.on('data', function(row) {
// row.toJSON() = {
// SingerId: 10,
// FirstName: 'Eddie',
// LastName: 'Wilson'
// }
}
})
.on('end', function() {
// All results retrieved.
});
```


## Cloud Speech (Alpha)

- [API Documentation][gcloud-speech-docs]
- [Official Documentation][cloud-speech-docs]
Expand Down Expand Up @@ -889,7 +889,7 @@ fs.createReadStream('./audio.raw')
```


## Google Cloud Translation API (Alpha)
## Cloud Translation API (Alpha)

- [API Documentation][gcloud-translate-docs]
- [Official Documentation][cloud-translate-docs]
Expand Down Expand Up @@ -958,7 +958,7 @@ translateClient.getLanguages(function(err, languages) {
```


## Google Cloud Vision (Alpha)
## Cloud Vision (Alpha)

- [API Documentation][gcloud-vision-docs]
- [Official Documentation][cloud-vision-docs]
Expand Down
2 changes: 1 addition & 1 deletion docs/authentication.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Authenticating with this module

It's incredibly easy to get authenticated and start using Google's APIs. You can set your credentials on a global basis as well as on a per-API basis. See each individual API section below to see how you can auth on a per-API-basis. This is useful if you want to use different accounts for different Google Cloud services.
It's incredibly easy to get authenticated and start using Google's APIs. You can set your credentials on a global basis as well as on a per-API basis. See each individual API section below to see how you can auth on a per-API-basis. This is useful if you want to use different accounts for different Cloud services.

```js
var config = {
Expand Down
4 changes: 2 additions & 2 deletions docs/faq.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Our library uses some native libraries, which must be recompiled against the pla
Reference Issues: [#1287](https://github.com/GoogleCloudPlatform/google-cloud-node/issues/1287), [#1297](https://github.com/GoogleCloudPlatform/google-cloud-node/issues/1297)


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

Google Cloud Node.js Client is a client library for using the broad set of Google APIs. This module 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.
Cloud Node.js Client is a client library for using the broad set of Google APIs. This module is built specifically for the Google Cloud Platform and is the recommended way to integrate 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
8 changes: 4 additions & 4 deletions docs/home.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<div class="container clearfix">
<div class="quote-box">
<h1>google-cloud</h1>
<p>Google Cloud Client Library for Node.js
<p>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
and Cloud Storage.</p>
Expand Down Expand Up @@ -156,20 +156,20 @@ <h3 class="block-title">FAQ</h3>
<h4>What is the relationship between the <code>google-cloud</code> package
and the <code>gcloud</code> command-line tool?</h4>
<p>Both the <code>gcloud</code> command-line tool and
<code>google-cloud</code> package are a part of the Google Cloud SDK: a collection
<code>google-cloud</code> package are a part of the 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>google-cloud</code> package is the
Google Cloud Client Library for Node.js.</p>
Cloud Client Library for Node.js.</p>

<h4>What is the relationship between <code>google-cloud</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>google-cloud</code> is built specifically for the Google Cloud Platform
and is the recommended way to integrate Google Cloud APIs into your
and is the recommended way to integrate 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>
</div>
Expand Down
Loading

0 comments on commit fdb06ea

Please sign in to comment.