From 758f4029409969bd740b5018a2a94e62bdf27f68 Mon Sep 17 00:00:00 2001 From: Stephen Sawchuk Date: Tue, 6 Dec 2016 13:18:23 -0500 Subject: [PATCH 1/4] prepare READMEs for beta release --- README.md | 736 ++++++++++++++--------------- packages/bigquery/README.md | 19 +- packages/bigtable/README.md | 17 +- packages/compute/README.md | 17 +- packages/datastore/README.md | 17 +- packages/dns/README.md | 17 +- packages/google-cloud/src/index.js | 45 +- packages/language/README.md | 19 +- packages/language/src/index.js | 6 - packages/logging/README.md | 19 +- packages/logging/src/index.js | 6 - packages/monitoring/README.md | 25 +- packages/monitoring/src/index.js | 6 - packages/prediction/README.md | 17 +- packages/pubsub/README.md | 17 +- packages/resource/README.md | 19 +- packages/resource/src/index.js | 10 +- packages/speech/README.md | 19 +- packages/speech/src/index.js | 6 - packages/storage/README.md | 17 +- packages/translate/README.md | 18 +- packages/translate/src/index.js | 6 - packages/vision/README.md | 19 +- packages/vision/src/index.js | 6 - 24 files changed, 465 insertions(+), 638 deletions(-) diff --git a/README.md b/README.md index 6fc81d93090..2103b88b826 100644 --- a/README.md +++ b/README.md @@ -10,39 +10,29 @@ * [Homepage][gcloud-homepage] * [API Documentation][gcloud-docs] -This client supports the following Google Cloud Platform services: - -* [Google BigQuery](#google-bigquery) -* [Google Cloud Bigtable](#google-cloud-bigtable) -* [Google Cloud Datastore](#google-cloud-datastore) -* [Google Cloud DNS](#google-cloud-dns) -* [Google Cloud Pub/Sub](#google-cloud-pubsub) -* [Google Cloud Storage](#google-cloud-storage) -* [Google Compute Engine](#google-compute-engine) -* [Google Prediction API](#google-prediction-api) -* [Google Translate API](#google-translate-api) -* [Google Cloud Natural Language](#google-cloud-natural-language-beta) (Beta) -* [Google Cloud Resource Manager](#google-cloud-resource-manager-beta) (Beta) -* [Google Cloud Speech](#google-cloud-speech-beta) (Beta) -* [Google Cloud Vision](#google-cloud-vision-beta) (Beta) -* [Stackdriver Logging](#stackdriver-logging-beta) (Beta) -* [Stackdriver Monitoring](#stackdriver-monitoring-beta) (Beta) +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) +* [Google Stackdriver Logging](#google-stackdriver-logging-beta) (Beta) + +This client supports the following Google Cloud Platform services at an [Alpha](#versioning) quality level: + +* [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 Vision](#google-cloud-vision-alpha) (Alpha) +* [Google Compute Engine](#google-compute-engine-alpha) (Alpha) +* [Google Prediction API](#google-prediction-api-alpha) (Alpha) +* [Google Stackdriver Monitoring](#google-stackdriver-monitoring-alpha) (Alpha) +* [Google Translate API](#google-translate-api-alpha) (Alpha) If you need support for other Google APIs, check out the [Google Node.js API Client library][googleapis]. -## Where did `gcloud-node` go? - -`gcloud-node` lives on under a new name, `google-cloud`. Your code will behave the same, simply change your dependency: - -```sh -$ npm uninstall --save gcloud -$ npm install --save google-cloud -``` - -```diff -- var gcloud = require('gcloud'); -+ var gcloud = require('google-cloud'); -``` ## Quick Start @@ -50,6 +40,7 @@ $ npm install --save google-cloud $ npm install --save google-cloud ``` + ## Example Applications - [nodejs-getting-started][nodejs-getting-started] - A sample and [tutorial][nodejs-getting-started-tutorial] that demonstrates how to build a complete web application using Cloud Datastore, Cloud Storage, and Cloud Pub/Sub and deploy it to Google App Engine or Google Compute Engine. @@ -60,27 +51,24 @@ $ npm install --save google-cloud - [gstore-node][gstore-node] - Google Datastore Entities Modeling library. - [gstore-api][gstore-api] - REST API builder for Google Datastore Entities. + ## 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. -### On Google Compute Engine +### On Google Cloud Platform 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. ``` js -// Authenticating on a global basis. -var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' -var gcloud = require('google-cloud')({ - projectId: projectId -}); - +var gcloud = require('google-cloud'); // ...you're good to go! See the next section to get started using the APIs. ``` + ### Elsewhere -If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account: +If you are not running this client on Google Cloud Platform, you need a Google Developers service account. To create a service account: 1. Visit the [Google Developers Console][dev-console]. 2. Create a new project or click on an existing project. @@ -129,7 +117,7 @@ var gcloud = require('google-cloud')({ You can also set auth on a per-API-instance basis. The examples below show you how. -## Google BigQuery +## Google BigQuery (Beta) - [API Documentation][gcloud-bigquery-docs] - [Official Documentation][cloud-bigquery-docs] @@ -184,78 +172,7 @@ job.getQueryResults().on('data', function(row) {}); ``` -## Google Cloud Bigtable - -- [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.* - -#### Using the all-in-one module - -``` -$ npm install --save google-cloud -``` - -```js -var gcloud = require('google-cloud'); -var bigtable = gcloud.bigtable; -``` - -#### Using the Cloud Bigtable API module - -``` -$ npm install --save @google-cloud/bigtable -``` - -```js -var bigtable = require('@google-cloud/bigtable'); -``` - -#### 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 bigtableClient = bigtable({ - projectId: 'grape-spaceship-123', - keyFilename: '/path/to/keyfile.json' -}); - -var instance = bigtableClient.instance('my-instance'); -var table = instance.table('prezzy'); - -table.getRows(function(err, rows) {}); - -// Update a row in your table. -var row = table.row('alincoln'); - -row.save('follows:gwashington', 1, function(err) { - if (err) { - // Error handling omitted. - } - - row.get('follows:gwashington', function(err, data) { - if (err) { - // Error handling omitted. - } - - // data = { - // follows: { - // gwashington: [ - // { - // value: 1 - // } - // ] - // } - // } - }); -}); -``` - - -## Google Cloud Datastore +## Google Cloud Datastore (Beta) - [API Documentation][gcloud-datastore-docs] - [Official Documentation][cloud-datastore-docs] @@ -329,124 +246,7 @@ datastoreClient.save({ ``` -## Google Cloud DNS - -- [API Documentation][gcloud-dns-docs] -- [Official Documentation][cloud-dns-docs] - -#### Using the all-in-one module - -``` -$ npm install --save google-cloud -``` - -```js -var gcloud = require('google-cloud'); -var dns = gcloud.dns; -``` - -#### Using the Cloud DNS API module - -``` -$ npm install --save @google-cloud/dns -``` - -```js -var dns = require('@google-cloud/dns'); -``` - -#### 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 dnsClient = dns({ - projectId: 'grape-spaceship-123', - keyFilename: '/path/to/keyfile.json' -}); - -// Create a managed zone. -dnsClient.createZone('my-new-zone', { - dnsName: 'my-domain.com.' -}, function(err, zone) {}); - -// Reference an existing zone. -var zone = dnsClient.zone('my-existing-zone'); - -// Create an NS record. -var nsRecord = zone.record('ns', { - ttl: 86400, - name: 'my-domain.com.', - data: 'ns-cloud1.googledomains.com.' -}); - -zone.addRecord(nsRecord, function(err, change) {}); - -// Create a zonefile from the records in your zone. -zone.export('/zonefile.zone', function(err) {}); -``` - - -## Google Cloud Pub/Sub - -- [API Documentation][gcloud-pubsub-docs] -- [Official Documentation][cloud-pubsub-docs] - -#### Using the all-in-one module - -``` -$ npm install --save google-cloud -``` - -```js -var gcloud = require('google-cloud'); -var pubsub = gcloud.pubsub; -``` - -#### Using the Cloud Pub/Sub API module - -``` -$ npm install --save @google-cloud/pubsub -``` - -```js -var pubsub = require('@google-cloud/pubsub'); -``` - -#### 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 pubsubClient = pubsub({ - projectId: 'grape-spaceship-123', - keyFilename: '/path/to/keyfile.json' -}); - -// Reference a topic that has been previously created. -var topic = pubsubClient.topic('my-topic'); - -// Publish a message to the topic. -topic.publish('New message!', function(err) {}); - -// Subscribe to the topic. -topic.subscribe('subscription-name', function(err, subscription) { - // Register listeners to start pulling for messages. - function onError(err) {} - function onMessage(message) {} - subscription.on('error', onError); - subscription.on('message', onMessage); - - // Remove listeners to stop pulling for messages. - subscription.removeListener('message', onMessage); - subscription.removeListener('error', onError); -}); -``` - - -## Google Cloud Storage +## Google Cloud Storage (Beta) - [API Documentation][gcloud-storage-docs] - [Official Documentation][cloud-storage-docs] @@ -518,10 +318,10 @@ localReadStream.pipe(remoteWriteStream); ``` -## Google Compute Engine +## Google Stackdriver Logging (Beta) -- [API Documentation][gcloud-compute-docs] -- [Official Documentation][cloud-compute-docs] +- [API Documentation][gcloud-logging-docs] +- [Official Documentation][cloud-logging-docs] #### Using the all-in-one module @@ -531,50 +331,71 @@ $ npm install --save google-cloud ```js var gcloud = require('google-cloud'); -var compute = gcloud.compute; +var logging = gcloud.logging; ``` -#### Using the Compute Engine API module +#### Using the Google Stackdriver Logging API module ``` -$ npm install --save @google-cloud/compute +$ npm install --save @google-cloud/logging ``` ```js -var compute = require('@google-cloud/compute'); +var logging = require('@google-cloud/logging'); ``` #### 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). +// Authenticating on a global-basis. You can also authenticate on a per-API- +// basis (see Authentication section above). -var gce = compute({ +var loggingClient = logging({ projectId: 'grape-spaceship-123', keyFilename: '/path/to/keyfile.json' }); -// Create a new VM using the latest OS image of your choice. -var zone = gce.zone('us-central1-a'); -var name = 'ubuntu-http'; +// Create a sink using a Bucket as a destination. +var gcs = storage(); -zone.createVM(name, { os: 'ubuntu' }, function(err, vm, operation) { - // `operation` lets you check the status of long-running tasks. +loggingClient.createSink('my-new-sink', { + destination: gcs.bucket('my-sink') +}, function(err, sink) {}); - operation - .on('error', function(err) {}) - .on('running', function(metadata) {}) - .on('complete', function(metadata) { - // Virtual machine created! - }); +// Write a critical entry to a log. +var syslog = loggingClient.log('syslog'); + +var metadata = { + resource: { + type: 'gce_instance', + labels: { + zone: 'global', + instance_id: '3' + } + } +}; + +var entry = syslog.entry(metadata, { + delegate: process.env.user +}); + +syslog.critical(entry, function(err) {}); + +// Get all entries in your project. +loggingClient.getEntries(function(err, entries) { + if (!err) { + // `entries` contains all of the entries from the logs in your project. + } }); ``` -## Google Prediction API -- [API Documentation][gcloud-prediction-docs] -- [Official Documentation][cloud-prediction-docs] +## Google 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.* #### Using the all-in-one module @@ -584,17 +405,17 @@ $ npm install --save google-cloud ```js var gcloud = require('google-cloud'); -var prediction = gcloud.prediction; +var bigtable = gcloud.bigtable; ``` -#### Using the Prediction API module +#### Using the Cloud Bigtable API module ``` -$ npm install --save @google-cloud/prediction +$ npm install --save @google-cloud/bigtable ``` ```js -var prediction = require('@google-cloud/prediction'); +var bigtable = require('@google-cloud/bigtable'); ``` #### Preview @@ -603,47 +424,47 @@ var prediction = require('@google-cloud/prediction'); // 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 predictionClient = prediction({ +var bigtableClient = bigtable({ projectId: 'grape-spaceship-123', keyFilename: '/path/to/keyfile.json' }); -// Get all of the trained models in your project. -predictionClient.getModels(function(err, models) { - if (!err) { - // `models` is an array of Model objects. - } -}); +var instance = bigtableClient.instance('my-instance'); +var table = instance.table('prezzy'); -// Reference an existing trained model. -var model = predictionClient.model('my-existing-model'); +table.getRows(function(err, rows) {}); -// Train a model. -model.train('english', 'Hello from your friends at Google!', function(err) {}); +// Update a row in your table. +var row = table.row('alincoln'); -// Query a model. -model.query('Hello', function(err, results) { - if (!err) { - // results.winner == 'english' - // results.scores == [ - // { - // label: 'english', - // score: 1 - // }, - // { - // label: 'spanish', - // score: 0 - // } - // ] +row.save('follows:gwashington', 1, function(err) { + if (err) { + // Error handling omitted. } + + row.get('follows:gwashington', function(err, data) { + if (err) { + // Error handling omitted. + } + + // data = { + // follows: { + // gwashington: [ + // { + // value: 1 + // } + // ] + // } + // } + }); }); ``` -## Google Translate API +## Google Cloud DNS (Alpha) -- [API Documentation][gcloud-translate-docs] -- [Official Documentation][cloud-translate-docs] +- [API Documentation][gcloud-dns-docs] +- [Official Documentation][cloud-dns-docs] #### Using the all-in-one module @@ -653,66 +474,53 @@ $ npm install --save google-cloud ```js var gcloud = require('google-cloud'); -var translate = gcloud.translate; +var dns = gcloud.dns; ``` -#### Using the Translate API module +#### Using the Cloud DNS API module ``` -$ npm install --save @google-cloud/translate +$ npm install --save @google-cloud/dns ``` ```js -var translate = require('@google-cloud/translate'); +var dns = require('@google-cloud/dns'); ``` -**An API key is required for Translate.** See [Identifying your application to Google][api-key-howto]. - #### 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 translateClient = translate({ - key: 'API Key' +var dnsClient = dns({ + projectId: 'grape-spaceship-123', + keyFilename: '/path/to/keyfile.json' }); -// Translate a string of text. -translateClient.translate('Hello', 'es', function(err, translation) { - if (!err) { - // translation = 'Hola' - } -}); +// Create a managed zone. +dnsClient.createZone('my-new-zone', { + dnsName: 'my-domain.com.' +}, function(err, zone) {}); -// Detect a language from a string of text. -translateClient.detect('Hello', function(err, results) { - if (!err) { - // results = { - // language: 'en', - // confidence: 1, - // input: 'Hello' - // } - } -}); +// Reference an existing zone. +var zone = dnsClient.zone('my-existing-zone'); -// Get a list of supported languages. -translateClient.getLanguages(function(err, languages) { - if (!err) { - // languages = [ - // 'af', - // 'ar', - // 'az', - // ... - // ] - } +// Create an NS record. +var nsRecord = zone.record('ns', { + ttl: 86400, + name: 'my-domain.com.', + data: 'ns-cloud1.googledomains.com.' }); -``` +zone.addRecord(nsRecord, function(err, change) {}); + +// Create a zonefile from the records in your zone. +zone.export('/zonefile.zone', function(err) {}); +``` -## Google Cloud Natural Language (Beta) -> **This is a Beta release of Google Cloud Natural Language.** This feature is not covered by any SLA or deprecation policy and may be subject to backward-incompatible changes. +## Google Cloud Natural Language (Alpha) - [API Documentation][gcloud-language-docs] - [Official Documentation][cloud-language-docs] @@ -794,9 +602,65 @@ document.annotate(function(err, annotations) { ``` -## Google Cloud Resource Manager (Beta) +## Google Cloud Pub/Sub (Alpha) + +- [API Documentation][gcloud-pubsub-docs] +- [Official Documentation][cloud-pubsub-docs] + +#### Using the all-in-one module + +``` +$ npm install --save google-cloud +``` + +```js +var gcloud = require('google-cloud'); +var pubsub = gcloud.pubsub; +``` + +#### Using the Cloud Pub/Sub API module + +``` +$ npm install --save @google-cloud/pubsub +``` + +```js +var pubsub = require('@google-cloud/pubsub'); +``` + +#### 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 pubsubClient = pubsub({ + projectId: 'grape-spaceship-123', + keyFilename: '/path/to/keyfile.json' +}); + +// Reference a topic that has been previously created. +var topic = pubsubClient.topic('my-topic'); + +// Publish a message to the topic. +topic.publish('New message!', function(err) {}); + +// Subscribe to the topic. +topic.subscribe('subscription-name', function(err, subscription) { + // Register listeners to start pulling for messages. + function onError(err) {} + function onMessage(message) {} + subscription.on('error', onError); + subscription.on('message', onMessage); + + // Remove listeners to stop pulling for messages. + subscription.removeListener('message', onMessage); + subscription.removeListener('error', onError); +}); +``` + -> **This is a Beta release of Google Cloud Resource Manager.** This feature is not covered by any SLA or deprecation policy and may be subject to backward-incompatible changes. +## Google Cloud Resource Manager (Alpha) - [API Documentation][gcloud-resource-docs] - [Official Documentation][cloud-resource-docs] @@ -849,9 +713,7 @@ project.getMetadata(function(err, metadata) { ``` -## Google Cloud Speech (Beta) - -> **This is a Beta release of Google Cloud Speech.** This feature is not covered by any SLA or deprecation policy and may be subject to backward-incompatible changes. +## Google Cloud Speech (Alpha) - [API Documentation][gcloud-speech-docs] - [Official Documentation][cloud-speech-docs] @@ -934,9 +796,7 @@ fs.createReadStream('./audio.raw') ``` -## Google Cloud Vision (Beta) - -> **This is a Beta release of Google Cloud Vision.** This feature is not covered by any SLA or deprecation policy and may be subject to backward-incompatible changes. +## Google Cloud Vision (Alpha) - [API Documentation][gcloud-vision-docs] - [Official Documentation][cloud-vision-docs] @@ -1065,12 +925,10 @@ visionClient.detectFaces('./image.jpg', function(err, faces) { ``` -## Stackdriver Logging (Beta) +## Google Compute Engine (Alpha) -> **This is a Beta release of Stackdriver Logging.** This API is not covered by any SLA or deprecation policy and may be subject to backward-incompatible changes. - -- [API Documentation][gcloud-logging-docs] -- [Official Documentation][cloud-logging-docs] +- [API Documentation][gcloud-compute-docs] +- [Official Documentation][cloud-compute-docs] #### Using the all-in-one module @@ -1080,68 +938,117 @@ $ npm install --save google-cloud ```js var gcloud = require('google-cloud'); -var logging = gcloud.logging; +var compute = gcloud.compute; ``` -#### Using the Stackdriver Logging API module +#### Using the Compute Engine API module ``` -$ npm install --save @google-cloud/logging +$ npm install --save @google-cloud/compute ``` ```js -var logging = require('@google-cloud/logging'); +var compute = require('@google-cloud/compute'); ``` #### Preview ```js -// Authenticating on a global-basis. You can also authenticate on a per-API- -// basis (see Authentication section above). +// 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 loggingClient = logging({ +var gce = compute({ projectId: 'grape-spaceship-123', keyFilename: '/path/to/keyfile.json' }); -// Create a sink using a Bucket as a destination. -var gcs = storage(); +// Create a new VM using the latest OS image of your choice. +var zone = gce.zone('us-central1-a'); +var name = 'ubuntu-http'; -loggingClient.createSink('my-new-sink', { - destination: gcs.bucket('my-sink') -}, function(err, sink) {}); +zone.createVM(name, { os: 'ubuntu' }, function(err, vm, operation) { + // `operation` lets you check the status of long-running tasks. -// Write a critical entry to a log. -var syslog = loggingClient.log('syslog'); + operation + .on('error', function(err) {}) + .on('running', function(metadata) {}) + .on('complete', function(metadata) { + // Virtual machine created! + }); +}); +``` -var metadata = { - resource: { - type: 'gce_instance', - labels: { - zone: 'global', - instance_id: '3' - } - } -}; -var entry = syslog.entry(metadata, { - delegate: process.env.user +## Google Prediction API (Alpha) + +- [API Documentation][gcloud-prediction-docs] +- [Official Documentation][cloud-prediction-docs] + +#### Using the all-in-one module + +``` +$ npm install --save google-cloud +``` + +```js +var gcloud = require('google-cloud'); +var prediction = gcloud.prediction; +``` + +#### Using the Prediction API module + +``` +$ npm install --save @google-cloud/prediction +``` + +```js +var prediction = require('@google-cloud/prediction'); +``` + +#### 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 predictionClient = prediction({ + projectId: 'grape-spaceship-123', + keyFilename: '/path/to/keyfile.json' }); -syslog.critical(entry, function(err) {}); +// Get all of the trained models in your project. +predictionClient.getModels(function(err, models) { + if (!err) { + // `models` is an array of Model objects. + } +}); -// Get all entries in your project. -loggingClient.getEntries(function(err, entries) { +// Reference an existing trained model. +var model = predictionClient.model('my-existing-model'); + +// Train a model. +model.train('english', 'Hello from your friends at Google!', function(err) {}); + +// Query a model. +model.query('Hello', function(err, results) { if (!err) { - // `entries` contains all of the entries from the logs in your project. + // results.winner == 'english' + // results.scores == [ + // { + // label: 'english', + // score: 1 + // }, + // { + // label: 'spanish', + // score: 0 + // } + // ] } }); ``` -## Stackdriver Monitoring (Beta) - -> **This is a Beta release of Stackdriver Monitoring.** This API is not covered by any SLA or deprecation policy and may be subject to backward-incompatible changes. +## Google Stackdriver Monitoring (Alpha) ### :warning: This is an auto-generated API @@ -1162,7 +1069,7 @@ var gcloud = require('google-cloud'); var monitoring = gcloud.monitoring; ``` -#### Using the Stackdriver Monitoring API module +#### Using the Google Stackdriver Monitoring API module ``` $ npm install --save @google-cloud/monitoring @@ -1182,15 +1089,98 @@ var monitoringClient = monitoring.v3({ ``` +## Google Translate API (Alpha) + +- [API Documentation][gcloud-translate-docs] +- [Official Documentation][cloud-translate-docs] + +#### Using the all-in-one module + +``` +$ npm install --save google-cloud +``` + +```js +var gcloud = require('google-cloud'); +var translate = gcloud.translate; +``` + +#### Using the Google Translate API module + +``` +$ npm install --save @google-cloud/translate +``` + +```js +var translate = require('@google-cloud/translate'); +``` + +#### 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 translateClient = translate({ + projectId: 'grape-spaceship-123', + keyFilename: '/path/to/keyfile.json' +}); + +// Translate a string of text. +translateClient.translate('Hello', 'es', function(err, translation) { + if (!err) { + // translation = 'Hola' + } +}); + +// Detect a language from a string of text. +translateClient.detect('Hello', function(err, results) { + if (!err) { + // results = { + // language: 'en', + // confidence: 1, + // input: 'Hello' + // } + } +}); + +// Get a list of supported languages. +translateClient.getLanguages(function(err, languages) { + if (!err) { + // languages = [ + // 'af', + // 'ar', + // 'az', + // ... + // ] + } +}); +``` + + +## Versioning + +This library follows [Semantic Versioning][semver]. + +Please note it is currently under active development. Any release versioned 0.x.y is subject to backwards incompatible changes at any time. + +**Beta**: Libraries defined at a Beta quality level are expected to be mostly stable and we're working towards their release candidate. We will address issues and requests with a higher priority. + +**Alpha**: Libraries defined at an Alpha quality level are still a work-in-progress and are more likely to get backwards-incompatible updates. + + + ## Contributing Contributions to this library are always welcome and highly encouraged. -See [CONTRIBUTING](.github/CONTRIBUTING.md) for more information on how to get started. +See [CONTRIBUTING][contributing] for more information on how to get started. + ## License -Apache 2.0 - See [COPYING](COPYING) for more information. +Apache 2.0 - See [COPYING][copying] for more information. + [gcloud-homepage]: https://googlecloudplatform.github.io/google-cloud-node/ [gcloud-docs]: https://googlecloudplatform.github.io/google-cloud-node/#/docs @@ -1257,3 +1247,9 @@ Apache 2.0 - See [COPYING](COPYING) for more information. [cloud-speech-docs]: https://cloud.google.com/speech/docs [cloud-vision-docs]: https://cloud.google.com/vision/docs + +[semver]: http://semver.org + +[contributing]: .github/CONTRIBUTING.md + +[copying]: COPYING.md \ No newline at end of file diff --git a/packages/bigquery/README.md b/packages/bigquery/README.md index 97f21a7fb5b..1031a65e625 100644 --- a/packages/bigquery/README.md +++ b/packages/bigquery/README.md @@ -1,4 +1,4 @@ -# @google-cloud/bigquery +# @google-cloud/bigquery ([Beta][versioning]) > Google BigQuery Client Library for Node.js *Looking for more Google APIs than just BigQuery? You might want to check out [`google-cloud`][google-cloud].* @@ -48,18 +48,12 @@ var bigquery = require('@google-cloud/bigquery')({ 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. -### On Google Compute Engine +### On Google Cloud Platform -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. +If you are running this client on Google Cloud Platform, 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. ``` js -// Authenticating on a global basis. -var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' - -var bigQuery = require('@google-cloud/bigquery')({ - projectId: projectId -}); - +var bigquery = require('@google-cloud/bigquery')(); // ...you're good to go! ``` @@ -78,7 +72,7 @@ If you are not running this client on Google Compute Engine, you need a Google D ``` js var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' -var bigQuery = require('@google-cloud/bigquery')({ +var bigquery = require('@google-cloud/bigquery')({ projectId: projectId, // The path to your key file: @@ -92,8 +86,9 @@ var bigQuery = require('@google-cloud/bigquery')({ ``` +[versioning]: https://github.com/readme.md#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project [gcloud-bigquery-docs]: https://googlecloudplatform.github.io/google-cloud-node/#/docs/bigquery -[cloud-bigquery-docs]: https://cloud.google.com/bigquery/what-is-bigquery +[cloud-bigquery-docs]: https://cloud.google.com/bigquery/what-is-bigquery \ No newline at end of file diff --git a/packages/bigtable/README.md b/packages/bigtable/README.md index 89da4d04e3e..7178f451aab 100644 --- a/packages/bigtable/README.md +++ b/packages/bigtable/README.md @@ -1,4 +1,4 @@ -# @google-cloud/bigtable +# @google-cloud/bigtable ([Alpha][versioning]) > Google Cloud Bigtable Client Library for Node.js *Looking for more Google APIs than just Bigtable? You might want to check out [`google-cloud`][google-cloud].* @@ -64,24 +64,18 @@ var bigtable = require('@google-cloud/bigtable')({ 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. -### On Google Compute Engine +### On Google Cloud Platform -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. +If you are running this client on Google Cloud Platform, 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. ``` js -// Authenticating on a global basis. -var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' - -var bigtable = require('@google-cloud/bigtable')({ - projectId: projectId -}); - +var bigtable = require('@google-cloud/bigtable')(); // ...you're good to go! ``` ### Elsewhere -If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account: +If you are not running this client on Google Cloud Platform, you need a Google Developers service account. To create a service account: 1. Visit the [Google Developers Console][dev-console]. 2. Create a new project or click on an existing project. @@ -110,6 +104,7 @@ var bigtable = require('@google-cloud/bigtable')({ ``` +[versioning]: https://github.com/readme.md#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/compute/README.md b/packages/compute/README.md index c3c12b0e279..5aa2747c4eb 100644 --- a/packages/compute/README.md +++ b/packages/compute/README.md @@ -1,4 +1,4 @@ -# @google-cloud/compute +# @google-cloud/compute ([Alpha][versioning]) > Google Compute Engine Client Library for Node.js *Looking for more Google APIs than just Compute Engine? You might want to check out [`google-cloud`][google-cloud].* @@ -54,24 +54,18 @@ var gce = require('@google-cloud/compute')({ 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. -### On Google Compute Engine +### On Google Cloud Platform -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. +If you are running this client on Google Cloud Platform, 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. ``` js -// Authenticating on a global basis. -var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' - -var gce = require('@google-cloud/compute')({ - projectId: projectId -}); - +var gce = require('@google-cloud/compute')(); // ...you're good to go! ``` ### Elsewhere -If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account: +If you are not running this client on Google Cloud Platform, you need a Google Developers service account. To create a service account: 1. Visit the [Google Developers Console][dev-console]. 2. Create a new project or click on an existing project. @@ -98,6 +92,7 @@ var gce = require('@google-cloud/compute')({ ``` +[versioning]: https://github.com/readme.md#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/datastore/README.md b/packages/datastore/README.md index 9e09143964b..261b703227d 100644 --- a/packages/datastore/README.md +++ b/packages/datastore/README.md @@ -1,4 +1,4 @@ -# @google-cloud/datastore +# @google-cloud/datastore ([Beta][versioning]) > Google Cloud Datastore Client Library for Node.js *Looking for more Google APIs than just Datastore? You might want to check out [`google-cloud`][google-cloud].* @@ -69,24 +69,18 @@ var datastore = require('@google-cloud/datastore')({ 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. -### On Google Compute Engine +### On Google Cloud Platform -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. +If you are running this client on Google Cloud Platform, 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. ``` js -// Authenticating on a global basis. -var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' - -var datastore = require('@google-cloud/datastore')({ - projectId: projectId -}); - +var datastore = require('@google-cloud/datastore')(); // ...you're good to go! ``` ### Elsewhere -If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account: +If you are not running this client on Google Cloud Platform, you need a Google Developers service account. To create a service account: 1. Visit the [Google Developers Console][dev-console]. 2. Create a new project or click on an existing project. @@ -113,6 +107,7 @@ var datastore = require('@google-cloud/datastore')({ ``` +[versioning]: https://github.com/readme.md#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/dns/README.md b/packages/dns/README.md index b819ea3fd13..33c928f333b 100644 --- a/packages/dns/README.md +++ b/packages/dns/README.md @@ -1,4 +1,4 @@ -# @google-cloud/dns +# @google-cloud/dns ([Alpha][versioning]) > Google Cloud DNS Client Library for Node.js *Looking for more Google APIs than just DNS? You might want to check out [`google-cloud`][google-cloud].* @@ -52,24 +52,18 @@ var dns = require('@google-cloud/dns')({ 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. -### On Google Compute Engine +### On Google Cloud Platform -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. +If you are running this client on Google Cloud Platform, 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. ``` js -// Authenticating on a global basis. -var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' - -var dns = require('@google-cloud/dns')({ - projectId: projectId -}); - +var dns = require('@google-cloud/dns')(); // ...you're good to go! ``` ### Elsewhere -If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account: +If you are not running this client on Google Cloud Platform, you need a Google Developers service account. To create a service account: 1. Visit the [Google Developers Console][dev-console]. 2. Create a new project or click on an existing project. @@ -96,6 +90,7 @@ var dns = require('@google-cloud/dns')({ ``` +[versioning]: https://github.com/readme.md#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/google-cloud/src/index.js b/packages/google-cloud/src/index.js index 4a4620cfc97..84c02db576c 100644 --- a/packages/google-cloud/src/index.js +++ b/packages/google-cloud/src/index.js @@ -132,12 +132,6 @@ var apis = { * API provides natural language understanding technologies to developers, * including sentiment analysis, entity recognition, and syntax analysis. * - *

- * **This is a Beta release of Google Cloud Natural Language.** This API is - * not covered by any SLA or deprecation policy and may be subject to - * backward-incompatible changes. - *

- * * @type {module:language} * * @return {module:language} @@ -156,12 +150,6 @@ var apis = { * store, search, analyze, monitor, and alert on log data and events from * Google Cloud Platform and Amazon Web Services (AWS). * - *

- * **This is a Beta release of Stackdriver Logging.** This API is not - * covered by any SLA or deprecation policy and may be subject to backward- - * incompatible changes. - *

- * * @type {module:logging} * * @return {module:logging} @@ -183,12 +171,6 @@ var apis = { * Web Server, Elasticsearch and many others. Stackdriver ingests that data * and generates insights via dashboards, charts, and alerts. * - *

- * **This is a Beta release of Stackdriver Monitoring.** This API is not - * covered by any SLA or deprecation policy and may be subject to - * backward-incompatible changes. - *

- * *

This is an auto-generated API

* * It does not follow the conventions you're familiar with from other parts of @@ -258,7 +240,7 @@ var apis = { pubsub: require('@google-cloud/pubsub'), /** - * [The Cloud Resource Manager](https://cloud.google.com/resource-manager/) + * The [Cloud Resource Manager](https://cloud.google.com/resource-manager/) * provides methods that you can use to programmatically manage your projects * in the Google Cloud Platform. With this API, you can do the following: * @@ -268,12 +250,6 @@ var apis = { * - Delete projects. * - Recover projects. * - *

- * **This is a Beta release of Cloud Resource Manager.** This feature is not - * covered by any SLA or deprecation policy and may be subject to backward- - * incompatible changes. - *

- * * @type {module:resource} * * @return {module:resource} @@ -293,12 +269,6 @@ var apis = { * applications. Send audio and receive a text transcription from the Cloud * Speech API service. * - *

- * **This is a Beta release of Google Cloud Speech.** This feature is not - * covered by any SLA or deprecation policy and may be subject to - * backward-incompatible changes. - *

- * * @type {module:speech} * * @return {module:speech} @@ -337,13 +307,6 @@ var apis = { * The Google Translate API lets websites and programs integrate with Google * Translate programmatically. * - * Google Translate API is available as a paid service. See the - * [Pricing](https://cloud.google.com/translate/v2/pricing.html) and - * [FAQ](https://cloud.google.com/translate/v2/faq.html) pages for details. - * - * **An API key is required for Translate.** See - * [Identifying your application to Google](https://cloud.google.com/translate/v2/using_rest#auth). - * * @type {module:translate} * * @return {module:translate} @@ -362,12 +325,6 @@ var apis = { * and landmark detection, optical character recognition (OCR), and tagging of * explicit content. * - *

- * **This is a Beta release of Google Cloud Vision.** This API is not - * covered by any SLA or deprecation policy and may be subject to backward- - * incompatible changes. - *

- * * To learn more about the Vision API, see the * [Getting Started guide](https://cloud.google.com/vision/docs/getting-started). * diff --git a/packages/language/README.md b/packages/language/README.md index da7d35ddc5f..4d80cdda05a 100644 --- a/packages/language/README.md +++ b/packages/language/README.md @@ -1,8 +1,6 @@ -# @google-cloud/language +# @google-cloud/language ([Alpha][versioning]) > Google Cloud Natural Language Client Library for Node.js -> **This is a Beta release of Google Cloud Natural Language.** This feature is not covered by any SLA or deprecation policy and may be subject to backward-incompatible changes. - *Looking for more Google APIs than just Natural Language? You might want to check out [`google-cloud`][google-cloud].* - [API Documentation][gcloud-language-docs] @@ -77,24 +75,18 @@ var language = require('@google-cloud/language')({ 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. -### On Google Compute Engine +### On Google Cloud Platform -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. +If you are running this client on Google Cloud Platform, 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. ``` js -// Authenticating on a global basis. -var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' - -var language = require('@google-cloud/language')({ - projectId: projectId -}); - +var language = require('@google-cloud/language')(); // ...you're good to go! ``` ### Elsewhere -If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account: +If you are not running this client on Google Cloud Platform, you need a Google Developers service account. To create a service account: 1. Visit the [Google Developers Console][dev-console]. 2. Create a new project or click on an existing project. @@ -121,6 +113,7 @@ var language = require('@google-cloud/language')({ ``` +[versioning]: https://github.com/readme.md#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/language/src/index.js b/packages/language/src/index.js index fe9c6061516..cd4e975cd90 100644 --- a/packages/language/src/index.js +++ b/packages/language/src/index.js @@ -32,12 +32,6 @@ var v1 = require('./v1'); var Document = require('./document.js'); /** - *

- * **This is a Beta release of Google Cloud Natural Language.** This API is - * not covered by any SLA or deprecation policy and may be subject to - * backward-incompatible changes. - *

- * * The [Google Cloud Natural Language](https://cloud.google.com/natural-language/docs) * API provides natural language understanding technologies to developers, * including sentiment analysis, entity recognition, and syntax analysis. This diff --git a/packages/logging/README.md b/packages/logging/README.md index db624cf152b..a3f4fd4d9c3 100644 --- a/packages/logging/README.md +++ b/packages/logging/README.md @@ -1,5 +1,5 @@ -# @google-cloud/logging -> Stackdriver Logging Client Library for Node.js +# @google-cloud/logging ([Alpha][versioning]) +> Google Stackdriver Logging Client Library for Node.js *Looking for more Google APIs than just Logging? You might want to check out [`google-cloud`][google-cloud].* @@ -69,24 +69,18 @@ var logging = require('@google-cloud/logging')({ 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. -### On Google Compute Engine +### On Google Cloud Platform -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. +If you are running this client on Google Cloud Platform, 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. ``` js -// Authenticating on a global basis. -var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' - -var logging = require('@google-cloud/logging')({ - projectId: projectId -}); - +var logging = require('@google-cloud/logging')(); // ...you're good to go! ``` ### Elsewhere -If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account: +If you are not running this client on Google Cloud Platform, you need a Google Developers service account. To create a service account: 1. Visit the [Google Developers Console][dev-console]. 2. Create a new project or click on an existing project. @@ -113,6 +107,7 @@ var logging = require('@google-cloud/logging')({ ``` +[versioning]: https://github.com/readme.md#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/logging/src/index.js b/packages/logging/src/index.js index c98f8b83c76..d9839e4094c 100644 --- a/packages/logging/src/index.js +++ b/packages/logging/src/index.js @@ -47,12 +47,6 @@ var Log = require('./log.js'); var Sink = require('./sink.js'); /** - *

- * **This is a Beta release of Stackdriver Logging.** This API is not covered - * by any SLA or deprecation policy and may be subject to - * backward-incompatible changes. - *

- * * [Stackdriver Logging](https://cloud.google.com/logging/docs) allows you to * store, search, analyze, monitor, and alert on log data and events from Google * Cloud Platform and Amazon Web Services (AWS). diff --git a/packages/monitoring/README.md b/packages/monitoring/README.md index 36bb4f93cae..2b36e9eb8c7 100644 --- a/packages/monitoring/README.md +++ b/packages/monitoring/README.md @@ -1,5 +1,5 @@ -# @google-cloud/monitoring -> Stackdriver Monitoring Client Library for Node.js +# @google-cloud/monitoring ([Alpha][versioning]) +> Google Stackdriver Monitoring Client Library for Node.js *Looking for more Google APIs than just Monitoring? You might want to check out [`google-cloud`][google-cloud].* @@ -27,24 +27,19 @@ var monitoring = require('@google-cloud/monitoring').v3({ 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. -### On Google Compute Engine +### On Google Cloud Platform -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. +If you are running this client on Google Cloud Platform, 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. ``` js // Authenticating on a global basis. -var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' - -var monitoring = require('@google-cloud/monitoring').v3({ - projectId: projectId -}); - +var monitoring = require('@google-cloud/monitoring').v3(); // ...you're good to go! ``` ### Elsewhere -If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account: +If you are not running this client on Google Cloud Platform, you need a Google Developers service account. To create a service account: 1. Visit the [Google Developers Console][dev-console]. 2. Create a new project or click on an existing project. @@ -53,11 +48,7 @@ If you are not running this client on Google Compute Engine, you need a Google D * 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. ``` js -var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' - -var monitoring = require('@google-cloud/monitoring')({ - projectId: projectId, - +var monitoring = require('@google-cloud/monitoring').v3({ // The path to your key file: keyFilename: '/path/to/keyfile.json' @@ -68,6 +59,8 @@ var monitoring = require('@google-cloud/monitoring')({ // ...you're good to go! ``` + +[versioning]: https://github.com/readme.md#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/monitoring/src/index.js b/packages/monitoring/src/index.js index 54269d4f581..7029aef0c7c 100644 --- a/packages/monitoring/src/index.js +++ b/packages/monitoring/src/index.js @@ -21,12 +21,6 @@ 'use strict'; /** - *

- * **This is a Beta release of Stackdriver Monitoring.** This API is not - * covered by any SLA or deprecation policy and may be subject to - * backward-incompatible changes. - *

- * * [Stackdriver Monitoring](https://cloud.google.com/monitoring/docs) collects * metrics, events, and metadata from Google Cloud Platform, Amazon Web Services * (AWS), hosted uptime probes, application instrumentation, and a variety of diff --git a/packages/prediction/README.md b/packages/prediction/README.md index 878b95e9c93..e967c70347f 100644 --- a/packages/prediction/README.md +++ b/packages/prediction/README.md @@ -1,4 +1,4 @@ -# @google-cloud/prediction +# @google-cloud/prediction ([Alpha][versioning]) > Google Prediction API Client Library for Node.js *Looking for more Google APIs than just Prediction? You might want to check out [`google-cloud`][google-cloud].* @@ -62,24 +62,18 @@ var prediction = require('@google-cloud/prediction')({ 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. -### On Google Compute Engine +### On Google Cloud Platform -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. +If you are running this client on Google Cloud Platform, 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. ``` js -// Authenticating on a global basis. -var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' - -var prediction = require('@google-cloud/prediction')({ - projectId: projectId -}); - +var prediction = require('@google-cloud/prediction')(); // ...you're good to go! ``` ### Elsewhere -If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account: +If you are not running this client on Google Cloud Platform, you need a Google Developers service account. To create a service account: 1. Visit the [Google Developers Console][dev-console]. 2. Create a new project or click on an existing project. @@ -106,6 +100,7 @@ var prediction = require('@google-cloud/prediction')({ ``` +[versioning]: https://github.com/readme.md#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/pubsub/README.md b/packages/pubsub/README.md index 877bb0846ae..e5db399c13b 100644 --- a/packages/pubsub/README.md +++ b/packages/pubsub/README.md @@ -1,4 +1,4 @@ -# @google-cloud/pubsub +# @google-cloud/pubsub ([Beta][versioning]) > Google Cloud Pub/Sub Client Library for Node.js *Looking for more Google APIs than just Pub/Sub? You might want to check out [`google-cloud`][google-cloud].* @@ -51,24 +51,18 @@ var pubsub = require('@google-cloud/pubsub')({ 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. -### On Google Compute Engine +### On Google Cloud Platform -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. +If you are running this client on Google Cloud Platform, 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. ``` js -// Authenticating on a global basis. -var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' - -var pubsub = require('@google-cloud/pubsub')({ - projectId: projectId -}); - +var pubsub = require('@google-cloud/pubsub')(); // ...you're good to go! ``` ### Elsewhere -If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account: +If you are not running this client on Google Cloud Platform, you need a Google Developers service account. To create a service account: 1. Visit the [Google Developers Console][dev-console]. 2. Create a new project or click on an existing project. @@ -95,6 +89,7 @@ var pubsub = require('@google-cloud/pubsub')({ ``` +[versioning]: https://github.com/readme.md#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/resource/README.md b/packages/resource/README.md index a22834e4d3b..b9c7310d548 100644 --- a/packages/resource/README.md +++ b/packages/resource/README.md @@ -1,8 +1,6 @@ -# @google-cloud/resource +# @google-cloud/resource ([Alpha][versioning]) > Google Cloud Resource Manager Client Library for Node.js -> **This is a Beta release of Google Cloud Resource Manager.** This feature is not covered by any SLA or deprecation policy and may be subject to backward-incompatible changes. - *Looking for more Google APIs than just Resource Manager? You might want to check out [`google-cloud`][google-cloud].* - [API Documentation][gcloud-resource-docs] @@ -48,24 +46,18 @@ var resource = require('@google-cloud/resource')({ 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. -### On Google Compute Engine +### On Google Cloud Platform -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. +If you are running this client on Google Cloud Platform, 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. ``` js -// Authenticating on a global basis. -var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' - -var resource = require('@google-cloud/resource')({ - projectId: projectId -}); - +var resource = require('@google-cloud/resource')(); // ...you're good to go! ``` ### Elsewhere -If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account: +If you are not running this client on Google Cloud Platform, you need a Google Developers service account. To create a service account: 1. Visit the [Google Developers Console][dev-console]. 2. Create a new project or click on an existing project. @@ -92,6 +84,7 @@ var resource = require('@google-cloud/resource')({ ``` +[versioning]: https://github.com/readme.md#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/resource/src/index.js b/packages/resource/src/index.js index 52f79b97b82..1f404708621 100644 --- a/packages/resource/src/index.js +++ b/packages/resource/src/index.js @@ -31,14 +31,8 @@ var util = require('util'); */ var Project = require('./project.js'); -/** - *

- * **This is a Beta release of Cloud Resource Manager.** This feature is not - * covered by any SLA or deprecation policy and may be subject to - * backward-incompatible changes. - *

- * - * [The Cloud Resource Manager](https://cloud.google.com/resource-manager/) +/** * + * The [Cloud Resource Manager](https://cloud.google.com/resource-manager/) * provides methods that you can use to programmatically manage your projects * in the Google Cloud Platform. With this API, you can do the following: * diff --git a/packages/speech/README.md b/packages/speech/README.md index f5816159d02..94ba770b951 100644 --- a/packages/speech/README.md +++ b/packages/speech/README.md @@ -1,8 +1,6 @@ -# @google-cloud/speech +# @google-cloud/speech ([Alpha][versioning]) > Google Cloud Speech Client Library for Node.js -> **This is a Beta release of Google Cloud Speech.** This feature is not covered by any SLA or deprecation policy and may be subject to backward-incompatible changes. - *Looking for more Google APIs than just Speech? You might want to check out [`google-cloud`][google-cloud].* - [API Documentation][gcloud-speech-docs] @@ -78,24 +76,18 @@ var speech = require('@google-cloud/speech')({ 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. -### On Google Compute Engine +### On Google Cloud Platform -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. +If you are running this client on Google Cloud Platform, 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. ``` js -// Authenticating on a global basis. -var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' - -var speech = require('@google-cloud/speech')({ - projectId: projectId -}); - +var speech = require('@google-cloud/speech')(); // ...you're good to go! ``` ### Elsewhere -If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account: +If you are not running this client on Google Cloud Platform, you need a Google Developers service account. To create a service account: 1. Visit the [Google Developers Console][dev-console]. 2. Create a new project or click on an existing project. @@ -122,6 +114,7 @@ var speech = require('@google-cloud/speech')({ ``` +[versioning]: https://github.com/readme.md#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/speech/src/index.js b/packages/speech/src/index.js index e2a0cfaed42..50e7e3e8c59 100644 --- a/packages/speech/src/index.js +++ b/packages/speech/src/index.js @@ -46,12 +46,6 @@ var v1beta1 = require('./v1beta1'); * @alias module:speech * * @classdesc - *

- * **This is a Beta release of Google Cloud Speech.** This feature is not - * covered by any SLA or deprecation policy and may be subject to - * backward-incompatible changes. - *

- * * To learn more about the Speech API, see the * [Getting Started guide](https://cloud.google.com/speech/docs/getting-started). * diff --git a/packages/storage/README.md b/packages/storage/README.md index 89f4988cd21..048b3f85026 100644 --- a/packages/storage/README.md +++ b/packages/storage/README.md @@ -1,4 +1,4 @@ -# @google-cloud/storage +# @google-cloud/storage ([Beta][versioning]) > Google Cloud Storage Client Library for Node.js *Looking for more Google APIs than just Storage? You might want to check out [`google-cloud`][google-cloud].* @@ -65,24 +65,18 @@ var gcs = require('@google-cloud/storage')({ 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. -### On Google Compute Engine +### On Google Cloud Platform -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. +If you are running this client on Google Cloud Platform, 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. ``` js -// Authenticating on a global basis. -var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' - -var gcs = require('@google-cloud/storage')({ - projectId: projectId -}); - +var gcs = require('@google-cloud/storage')(); // ...you're good to go! ``` ### Elsewhere -If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account: +If you are not running this client on Google Cloud Platform, you need a Google Developers service account. To create a service account: 1. Visit the [Google Developers Console][dev-console]. 2. Create a new project or click on an existing project. @@ -110,6 +104,7 @@ var gcs = require('@google-cloud/storage')({ ``` +[versioning]: https://github.com/readme.md#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/translate/README.md b/packages/translate/README.md index 62eae7cc405..f6aac78fc64 100644 --- a/packages/translate/README.md +++ b/packages/translate/README.md @@ -1,4 +1,4 @@ -# @google-cloud/translate +# @google-cloud/translate ([Alpha][versioning]) > Google Translate API Client Library for Node.js *Looking for more Google APIs than just Translate? You might want to check out [`google-cloud`][google-cloud].* @@ -62,24 +62,18 @@ var translate = require('@google-cloud/translate')({ 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. -### On Google Compute Engine +### On Google Cloud Platform -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. +If you are running this client on Google Cloud Platform, 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. ``` js -// Authenticating on a global basis. -var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' - -var translate = require('@google-cloud/translate')({ - projectId: projectId -}); - +var translate = require('@google-cloud/translate')(); // ...you're good to go! ``` ### With a Google Developers Service Account -If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account: +If you are not running this client on Google Cloud Platform, you need a Google Developers service account. To create a service account: 1. Visit the [Google Developers Console][dev-console]. 2. Create a new project or click on an existing project. @@ -128,6 +122,8 @@ var translate = require('@google-cloud/translate')({ // ...you're good to go! ``` + +[versioning]: https://github.com/readme.md#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ [api-key-howto]: https://cloud.google.com/translate/v2/using_rest#auth [gcloud-translate-docs]: https://googlecloudplatform.github.io/google-cloud-node/#/docs/translate diff --git a/packages/translate/src/index.js b/packages/translate/src/index.js index e4cac3bec34..f178a01ae04 100644 --- a/packages/translate/src/index.js +++ b/packages/translate/src/index.js @@ -37,18 +37,12 @@ var PKG = require('../package.json'); * The Google Translate API lets websites and programs integrate with Google * Translate programmatically. * - * Google Translate API is available as a paid service. See the - * [Pricing](https://cloud.google.com/translate/v2/pricing.html) and - * [FAQ](https://cloud.google.com/translate/v2/faq.html) pages for details. - * * @constructor * @alias module:translate * * @resource [Getting Started]{@link https://cloud.google.com/translate/v2/getting_started} * @resource [Identifying your application to Google]{@link https://cloud.google.com/translate/v2/using_rest#auth} * - * @throws {Error} If an API key is not provided. - * * @param {object} options - [Configuration object](#/docs). * @param {string=} options.key - An API key. * diff --git a/packages/vision/README.md b/packages/vision/README.md index 7e70bb2576e..87d005330a2 100644 --- a/packages/vision/README.md +++ b/packages/vision/README.md @@ -1,8 +1,6 @@ -# @google-cloud/vision +# @google-cloud/vision ([Alpha][versioning]) > Google Cloud Vision Client Library for Node.js -> **This is a Beta release of Google Cloud Vision.** This feature is not covered by any SLA or deprecation policy and may be subject to backward-incompatible changes. - *Looking for more Google APIs than just Vision? You might want to check out [`google-cloud`][google-cloud].* - [API Documentation][gcloud-vision-docs] @@ -124,24 +122,18 @@ var vision = require('@google-cloud/vision')({ 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. -### On Google Compute Engine +### On Google Cloud Platform -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. +If you are running this client on Google Cloud Platform, 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. ``` js -// Authenticating on a global basis. -var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123' - -var vision = require('@google-cloud/vision')({ - projectId: projectId -}); - +var vision = require('@google-cloud/vision')(); // ...you're good to go! ``` ### Elsewhere -If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account: +If you are not running this client on Google Cloud Platform, you need a Google Developers service account. To create a service account: 1. Visit the [Google Developers Console][dev-console]. 2. Create a new project or click on an existing project. @@ -168,6 +160,7 @@ var vision = require('@google-cloud/vision')({ ``` +[versioning]: https://github.com/readme.md#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/vision/src/index.js b/packages/vision/src/index.js index b7dcd4a0967..77e09f5932b 100644 --- a/packages/vision/src/index.js +++ b/packages/vision/src/index.js @@ -39,12 +39,6 @@ var LIKELY = 3; var VERY_LIKELY = 4; /** - *

- * **This is a Beta release of Google Cloud Vision.** This API is not covered - * by any SLA or deprecation policy and may be subject to backward- - * incompatible changes. - *

- * * The [Cloud Vision API](https://cloud.google.com/vision/docs) allows easy * integration of vision detection features, including image labeling, face and * landmark detection, optical character recognition (OCR), and tagging of From 959b9467b4318f800c862ccd84f2b30d835ecf32 Mon Sep 17 00:00:00 2001 From: Stephen Sawchuk Date: Tue, 6 Dec 2016 13:20:25 -0500 Subject: [PATCH 2/4] fix copying link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2103b88b826..6ec078c24cc 100644 --- a/README.md +++ b/README.md @@ -1252,4 +1252,4 @@ Apache 2.0 - See [COPYING][copying] for more information. [contributing]: .github/CONTRIBUTING.md -[copying]: COPYING.md \ No newline at end of file +[copying]: COPYING \ No newline at end of file From 3f01bf99e8bda03ca7baf22762abff7dc4cf4922 Mon Sep 17 00:00:00 2001 From: Stephen Sawchuk Date: Tue, 6 Dec 2016 13:22:43 -0500 Subject: [PATCH 3/4] correct #versioning links --- packages/bigquery/README.md | 2 +- packages/bigtable/README.md | 2 +- packages/compute/README.md | 2 +- packages/datastore/README.md | 2 +- packages/dns/README.md | 2 +- packages/language/README.md | 2 +- packages/logging/README.md | 2 +- packages/monitoring/README.md | 2 +- packages/prediction/README.md | 2 +- packages/pubsub/README.md | 2 +- packages/resource/README.md | 2 +- packages/speech/README.md | 2 +- packages/storage/README.md | 2 +- packages/translate/README.md | 2 +- packages/vision/README.md | 2 +- 15 files changed, 15 insertions(+), 15 deletions(-) diff --git a/packages/bigquery/README.md b/packages/bigquery/README.md index 1031a65e625..d3daac59cc9 100644 --- a/packages/bigquery/README.md +++ b/packages/bigquery/README.md @@ -86,7 +86,7 @@ var bigquery = require('@google-cloud/bigquery')({ ``` -[versioning]: https://github.com/readme.md#versioning +[versioning]: https://github.com/GoogleCloudPlatform/google-cloud-node#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/bigtable/README.md b/packages/bigtable/README.md index 7178f451aab..64ac102ce5c 100644 --- a/packages/bigtable/README.md +++ b/packages/bigtable/README.md @@ -104,7 +104,7 @@ var bigtable = require('@google-cloud/bigtable')({ ``` -[versioning]: https://github.com/readme.md#versioning +[versioning]: https://github.com/GoogleCloudPlatform/google-cloud-node#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/compute/README.md b/packages/compute/README.md index 5aa2747c4eb..f417a681794 100644 --- a/packages/compute/README.md +++ b/packages/compute/README.md @@ -92,7 +92,7 @@ var gce = require('@google-cloud/compute')({ ``` -[versioning]: https://github.com/readme.md#versioning +[versioning]: https://github.com/GoogleCloudPlatform/google-cloud-node#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/datastore/README.md b/packages/datastore/README.md index 261b703227d..6241d31d977 100644 --- a/packages/datastore/README.md +++ b/packages/datastore/README.md @@ -107,7 +107,7 @@ var datastore = require('@google-cloud/datastore')({ ``` -[versioning]: https://github.com/readme.md#versioning +[versioning]: https://github.com/GoogleCloudPlatform/google-cloud-node#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/dns/README.md b/packages/dns/README.md index 33c928f333b..87c49413c76 100644 --- a/packages/dns/README.md +++ b/packages/dns/README.md @@ -90,7 +90,7 @@ var dns = require('@google-cloud/dns')({ ``` -[versioning]: https://github.com/readme.md#versioning +[versioning]: https://github.com/GoogleCloudPlatform/google-cloud-node#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/language/README.md b/packages/language/README.md index 4d80cdda05a..d586725cbcc 100644 --- a/packages/language/README.md +++ b/packages/language/README.md @@ -113,7 +113,7 @@ var language = require('@google-cloud/language')({ ``` -[versioning]: https://github.com/readme.md#versioning +[versioning]: https://github.com/GoogleCloudPlatform/google-cloud-node#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/logging/README.md b/packages/logging/README.md index a3f4fd4d9c3..d7e4761cdc6 100644 --- a/packages/logging/README.md +++ b/packages/logging/README.md @@ -107,7 +107,7 @@ var logging = require('@google-cloud/logging')({ ``` -[versioning]: https://github.com/readme.md#versioning +[versioning]: https://github.com/GoogleCloudPlatform/google-cloud-node#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/monitoring/README.md b/packages/monitoring/README.md index 2b36e9eb8c7..1a04f7beb2d 100644 --- a/packages/monitoring/README.md +++ b/packages/monitoring/README.md @@ -60,7 +60,7 @@ var monitoring = require('@google-cloud/monitoring').v3({ ``` -[versioning]: https://github.com/readme.md#versioning +[versioning]: https://github.com/GoogleCloudPlatform/google-cloud-node#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/prediction/README.md b/packages/prediction/README.md index e967c70347f..462907575b5 100644 --- a/packages/prediction/README.md +++ b/packages/prediction/README.md @@ -100,7 +100,7 @@ var prediction = require('@google-cloud/prediction')({ ``` -[versioning]: https://github.com/readme.md#versioning +[versioning]: https://github.com/GoogleCloudPlatform/google-cloud-node#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/pubsub/README.md b/packages/pubsub/README.md index e5db399c13b..5f8a0aea02d 100644 --- a/packages/pubsub/README.md +++ b/packages/pubsub/README.md @@ -89,7 +89,7 @@ var pubsub = require('@google-cloud/pubsub')({ ``` -[versioning]: https://github.com/readme.md#versioning +[versioning]: https://github.com/GoogleCloudPlatform/google-cloud-node#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/resource/README.md b/packages/resource/README.md index b9c7310d548..225e315275c 100644 --- a/packages/resource/README.md +++ b/packages/resource/README.md @@ -84,7 +84,7 @@ var resource = require('@google-cloud/resource')({ ``` -[versioning]: https://github.com/readme.md#versioning +[versioning]: https://github.com/GoogleCloudPlatform/google-cloud-node#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/speech/README.md b/packages/speech/README.md index 94ba770b951..fb0d872e9ec 100644 --- a/packages/speech/README.md +++ b/packages/speech/README.md @@ -114,7 +114,7 @@ var speech = require('@google-cloud/speech')({ ``` -[versioning]: https://github.com/readme.md#versioning +[versioning]: https://github.com/GoogleCloudPlatform/google-cloud-node#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/storage/README.md b/packages/storage/README.md index 048b3f85026..c9db96d1451 100644 --- a/packages/storage/README.md +++ b/packages/storage/README.md @@ -104,7 +104,7 @@ var gcs = require('@google-cloud/storage')({ ``` -[versioning]: https://github.com/readme.md#versioning +[versioning]: https://github.com/GoogleCloudPlatform/google-cloud-node#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project diff --git a/packages/translate/README.md b/packages/translate/README.md index f6aac78fc64..04a7bf8ce91 100644 --- a/packages/translate/README.md +++ b/packages/translate/README.md @@ -123,7 +123,7 @@ var translate = require('@google-cloud/translate')({ ``` -[versioning]: https://github.com/readme.md#versioning +[versioning]: https://github.com/GoogleCloudPlatform/google-cloud-node#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ [api-key-howto]: https://cloud.google.com/translate/v2/using_rest#auth [gcloud-translate-docs]: https://googlecloudplatform.github.io/google-cloud-node/#/docs/translate diff --git a/packages/vision/README.md b/packages/vision/README.md index 87d005330a2..35894b20545 100644 --- a/packages/vision/README.md +++ b/packages/vision/README.md @@ -160,7 +160,7 @@ var vision = require('@google-cloud/vision')({ ``` -[versioning]: https://github.com/readme.md#versioning +[versioning]: https://github.com/GoogleCloudPlatform/google-cloud-node#versioning [google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using [dev-console]: https://console.developers.google.com/project From b3d1312696d939501ed2eec9c3e5d4ed197eb9d1 Mon Sep 17 00:00:00 2001 From: Stephen Sawchuk Date: Thu, 8 Dec 2016 10:37:40 -0500 Subject: [PATCH 4/4] correct Alpha/Beta declaration --- README.md | 2 +- packages/logging/README.md | 2 +- packages/pubsub/README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6ec078c24cc..11697f33b0b 100644 --- a/README.md +++ b/README.md @@ -1252,4 +1252,4 @@ Apache 2.0 - See [COPYING][copying] for more information. [contributing]: .github/CONTRIBUTING.md -[copying]: COPYING \ No newline at end of file +[copying]: COPYING diff --git a/packages/logging/README.md b/packages/logging/README.md index d7e4761cdc6..5c6bbcb0bd0 100644 --- a/packages/logging/README.md +++ b/packages/logging/README.md @@ -1,4 +1,4 @@ -# @google-cloud/logging ([Alpha][versioning]) +# @google-cloud/logging ([Beta][versioning]) > Google Stackdriver Logging Client Library for Node.js *Looking for more Google APIs than just Logging? You might want to check out [`google-cloud`][google-cloud].* diff --git a/packages/pubsub/README.md b/packages/pubsub/README.md index 5f8a0aea02d..11d79515f49 100644 --- a/packages/pubsub/README.md +++ b/packages/pubsub/README.md @@ -1,4 +1,4 @@ -# @google-cloud/pubsub ([Beta][versioning]) +# @google-cloud/pubsub ([Alpha][versioning]) > Google Cloud Pub/Sub Client Library for Node.js *Looking for more Google APIs than just Pub/Sub? You might want to check out [`google-cloud`][google-cloud].*