Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

prepare READMEs for beta release #1864

Merged
merged 4 commits into from
Dec 8, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
736 changes: 366 additions & 370 deletions README.md

Large diffs are not rendered by default.

19 changes: 7 additions & 12 deletions packages/bigquery/README.md
Original file line number Diff line number Diff line change
@@ -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].*
Expand Down Expand Up @@ -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!
```

Expand All @@ -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:
Expand All @@ -92,8 +86,9 @@ var bigQuery = require('@google-cloud/bigquery')({
```


[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
[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
17 changes: 6 additions & 11 deletions packages/bigtable/README.md
Original file line number Diff line number Diff line change
@@ -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].*
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -110,6 +104,7 @@ var bigtable = require('@google-cloud/bigtable')({
```


[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
Expand Down
17 changes: 6 additions & 11 deletions packages/compute/README.md
Original file line number Diff line number Diff line change
@@ -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].*
Expand Down Expand Up @@ -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.
Expand All @@ -98,6 +92,7 @@ var gce = require('@google-cloud/compute')({
```


[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
Expand Down
17 changes: 6 additions & 11 deletions packages/datastore/README.md
Original file line number Diff line number Diff line change
@@ -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].*
Expand Down Expand Up @@ -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.
Expand All @@ -113,6 +107,7 @@ var datastore = require('@google-cloud/datastore')({
```


[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
Expand Down
17 changes: 6 additions & 11 deletions packages/dns/README.md
Original file line number Diff line number Diff line change
@@ -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].*
Expand Down Expand Up @@ -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.
Expand All @@ -96,6 +90,7 @@ var dns = require('@google-cloud/dns')({
```


[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
Expand Down
45 changes: 1 addition & 44 deletions packages/google-cloud/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -132,12 +132,6 @@ var apis = {
* API provides natural language understanding technologies to developers,
* including sentiment analysis, entity recognition, and syntax analysis.
*
* <p class="notice">
* **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.
* </p>
*
* @type {module:language}
*
* @return {module:language}
Expand All @@ -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).
*
* <p class="notice">
* **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.
* </p>
*
* @type {module:logging}
*
* @return {module:logging}
Expand All @@ -183,12 +171,6 @@ var apis = {
* Web Server, Elasticsearch and many others. Stackdriver ingests that data
* and generates insights via dashboards, charts, and alerts.
*
* <p class="notice">
* **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.
* </p>
*
* <h2>This is an auto-generated API</h2>
*
* It does not follow the conventions you're familiar with from other parts of
Expand Down Expand Up @@ -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:
*
Expand All @@ -268,12 +250,6 @@ var apis = {
* - Delete projects.
* - Recover projects.
*
* <p class="notice">
* **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.
* </p>
*
* @type {module:resource}
*
* @return {module:resource}
Expand All @@ -293,12 +269,6 @@ var apis = {
* applications. Send audio and receive a text transcription from the Cloud
* Speech API service.
*
* <p class="notice">
* **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.
* </p>
*
* @type {module:speech}
*
* @return {module:speech}
Expand Down Expand Up @@ -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}
Expand All @@ -362,12 +325,6 @@ var apis = {
* and landmark detection, optical character recognition (OCR), and tagging of
* explicit content.
*
* <p class="notice">
* **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.
* </p>
*
* To learn more about the Vision API, see the
* [Getting Started guide](https://cloud.google.com/vision/docs/getting-started).
*
Expand Down
19 changes: 6 additions & 13 deletions packages/language/README.md
Original file line number Diff line number Diff line change
@@ -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]
Expand Down Expand Up @@ -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.
Expand All @@ -121,6 +113,7 @@ var language = require('@google-cloud/language')({
```


[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
Expand Down
6 changes: 0 additions & 6 deletions packages/language/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,6 @@ var v1 = require('./v1');
var Document = require('./document.js');

/**
* <p class="notice">
* **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.
* </p>
*
* 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
Expand Down
Loading