Update READMEs and home.html

[refs #831]
googleapis · Aug 24, 2016 · e7df1d7 · e7df1d7
1 parent 956fbba
commit e7df1d7
Show file tree

Hide file tree

Showing 11 changed files with 180 additions and 84 deletions.
diff --git a/README.md b/README.md
@@ -7,11 +7,12 @@ Idiomatic Ruby client for [Google Cloud Platform](https://cloud.google.com/) ser
 [![Gem Version](https://badge.fury.io/rb/gcloud.svg)](http://badge.fury.io/rb/gcloud)
 
 * [Homepage](http://googlecloudplatform.github.io/gcloud-ruby/)
-* [API Documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs)
+* [API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs)
+* [google-cloud on RubyGems](https://rubygems.org/gems/google-cloud)
 
 ## Ruby API Client library for Google Cloud
 
-This client supports the following Google Cloud Platform services:
+This project supports the following Google Cloud Platform services:
 
 * [BigQuery](#bigquery)
 * [Cloud Datastore](#datastore)
@@ -23,24 +24,38 @@ This client supports the following Google Cloud Platform services:
 * [Google Translate API](#translate)
 * [Cloud Vision API](#vision)
 
+The support for each service is distributed as a separate gem. However, for your convenience, the `google-cloud` gem lets you install the entire collection.
+
 If you need support for other Google APIs, check out the [Google API Ruby Client library](https://github.com/google/google-api-ruby-client).
 
 ## Quick Start
 
 ```sh
-$ gem install gcloud
+$ gem install google-cloud
 ```
 
+The `google-cloud` gem shown above provides all of the individual service gems in the gcloud-ruby project, making it easy to explore Google Cloud Platform. To avoid unnecessary dependencies, you can also install the service gems independently.
+
 ### Authentication
 
-The gcloud-ruby library uses Service Account credentials to connect to Google Cloud services. When running on Compute Engine the credentials will be discovered automatically. When running on other environments the Service Account credentials can be specified by providing the path to the JSON file, or the JSON itself, in environment variables. Additionally, Cloud SDK credentials can also be discovered automatically, but this is only recommended during development.
+In general, the gcloud-ruby library uses [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts) credentials to connect to Google Cloud services. When running on Compute Engine the credentials will be discovered automatically. When running on other environments, the Service Account credentials can be specified by providing the path to the [JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys) for the account (or the JSON itself) in environment variables. Additionally, Cloud SDK credentials can also be discovered automatically, but this is only recommended during development.
+
+General instructions, environment variables, and configuration options are covered in the general [Authentication guide](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud/guides/authentication) for the `google-cloud` umbrella package. Specific instructions and environment variables for each individual service are linked from the README documents listed below for each service.
 
-Instructions and configuration options are covered in the [Authentication guide](AUTHENTICATION.md). The examples in Quick Start will demonstrate providing the **Project ID** and **Credentials JSON file path** in code.
+The preview examples below demonstrate how to provide the **Project ID** and **Credentials JSON file path** directly in code.
 
 ### BigQuery
 
-- [gcloud-ruby BigQuery API Documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/gcloud/bigquery)
-- [Google Cloud BigQuery Documentation](https://cloud.google.com/bigquery/docs)
+- [google-cloud-bigquery README](google-cloud-bigquery/README.md)
+- [google-cloud-bigquery API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-bigquery)
+- [google-cloud-bigquery on RubyGems](https://rubygems.org/gems/google-cloud-bigquery)
+- [Google Cloud BigQuery documentation](https://cloud.google.com/bigquery/docs)
+
+#### Quick Start
+
+```sh
+$ gem install google-cloud-bigquery
+```
 
 #### Preview
 
@@ -71,11 +86,19 @@ end
 
 ### Datastore
 
-- [gcloud-ruby Datastore API Documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/gcloud/datastore)
-- [Google Cloud Datastore Documentation](https://cloud.google.com/datastore/docs)
+- [google-cloud-datastore README](google-cloud-datastore/README.md)
+- [google-cloud-datastore API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-datastore)
+- [google-cloud-datastore on RubyGems](https://rubygems.org/gems/google-cloud-datastore)
+- [Google Cloud Datastore documentation](https://cloud.google.com/datastore/docs)
 
 *Follow the [activation instructions](https://cloud.google.com/datastore/docs/activate) to use the Google Cloud Datastore API with your project.*
 
+#### Quick Start
+
+```sh
+$ gem install google-cloud-datastore
+```
+
 #### Preview
 
 ```ruby
@@ -104,8 +127,16 @@ tasks = datastore.run query
 
 ### DNS
 
-- [gcloud-ruby DNS API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/gcloud/dns)
-- [Google Cloud DNS Documentation](https://cloud.google.com/dns/docs)
+- [google-cloud-dns README](google-cloud-dns/README.md)
+- [google-cloud-dns API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-dns)
+- [google-cloud-dns on RubyGems](https://rubygems.org/gems/google-cloud-dns)
+- [Google Cloud DNS documentation](https://cloud.google.com/dns/docs)
+
+#### Quick Start
+
+```sh
+$ gem install google-cloud-dns
+```
 
 #### Preview
 
@@ -133,8 +164,16 @@ end
 
 ### Logging
 
-- [gcloud-ruby Logging API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/gcloud/logging)
-- [Stackdriver Logging Documentation](https://cloud.google.com/logging/docs/)
+- [google-cloud-logging README](google-cloud-logging/README.md)
+- [google-cloud-logging API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-logging)
+- [google-cloud-logging on RubyGems](https://rubygems.org/gems/google-cloud-logging)
+- [Stackdriver Logging documentation](https://cloud.google.com/logging/docs/)
+
+#### Quick Start
+
+```sh
+$ gem install google-cloud-logging
+```
 
 #### Preview
 
@@ -165,8 +204,16 @@ logging.write_entries entry
 
 ### Pub/Sub
 
-- [gcloud-ruby Pub/Sub API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/gcloud/pubsub)
-- [Google Cloud Pub/Sub Documentation](https://cloud.google.com/pubsub/docs)
+- [google-cloud-pubsub README](google-cloud-pubsub/README.md)
+- [[google-cloud-pubsub API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-pubsub)
+- [[google-cloud-pubsub on RubyGems](https://rubygems.org/gems/[google-cloud-pubsub)
+- [Google Cloud Pub/Sub documentation](https://cloud.google.com/pubsub/docs)
+
+#### Quick Start
+
+```sh
+$ gem install google-cloud-pubsub
+```
 
 #### Preview
 
@@ -192,8 +239,16 @@ msgs = sub.pull
 
 ### Resource Manager
 
-- [gcloud-ruby Resource Manager API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/gcloud/resourcemanager)
-- [Google Cloud Resource Manager Documentation](https://cloud.google.com/resource-manager/)
+- [google-cloud-resource_manager README](google-cloud-resource_manager/README.md)
+- [google-cloud-resource_manager API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-resource_manager)
+- [google-cloud-resource_manager on RubyGems](https://rubygems.org/gems/google-cloud-resource_manager)
+- [Google Cloud Resource Manager documentation](https://cloud.google.com/resource-manager/)
+
+#### Quick Start
+
+```sh
+$ gem install google-cloud-resource_manager
+```
 
 #### Preview
 
@@ -220,8 +275,16 @@ projects = resource_manager.projects filter: "labels.env:production"
 
 ### Storage
 
-- [gcloud-ruby Storage API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/gcloud/storage)
-- [Google Cloud Storage Documentation](https://cloud.google.com/storage/docs)
+- [google-cloud-storage README](google-cloud-storage/README.md)
+- [google-cloud-storage API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-storage)
+- [google-cloud-storage on RubyGems](https://rubygems.org/gems/google-cloud-storage)
+- [Google Cloud Storage documentation](https://cloud.google.com/storage/docs)
+
+#### Quick Start
+
+```sh
+$ gem install google-cloud-storage
+```
 
 #### Preview
 
@@ -246,8 +309,16 @@ file.copy backup, file.name
 
 ### Translate
 
-- [gcloud-ruby Translate API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/gcloud/translate)
-- [Google Translate Documentation](https://cloud.google.com/translate/docs)
+- [google-cloud-translate README](google-cloud-translate/README.md)
+- [google-cloud-translate API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-translate)
+- [google-cloud-translate on RubyGems](https://rubygems.org/gems/google-cloud-translate)
+- [Google Translate documentation](https://cloud.google.com/translate/docs)
+
+#### Quick Start
+
+```sh
+$ gem install google-cloud-translate
+```
 
 #### Preview
 
@@ -269,8 +340,16 @@ translation.text #=> "Salve mundi!"
 
 ### Vision
 
-- [gcloud-ruby Vision API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/gcloud/vision)
-- [Google Cloud Vision Documentation](https://cloud.google.com/vision/docs)
+- [google-cloud-vision README](google-cloud-vision/README.md)
+- [gcloud-ruby-vision API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-vision)
+- [google-cloud-vision on RubyGems](https://rubygems.org/gems/google-cloud-vision)
+- [Google Cloud Vision documentation](https://cloud.google.com/vision/docs)
+
+#### Quick Start
+
+```sh
+$ gem install google-cloud-vision
+```
 
 #### Preview
 

diff --git a/docs/json/home.html b/docs/json/home.html
@@ -10,7 +10,7 @@ <h1>gcloud</h1>
 
     <div class="quote-box--supplementary">
       <h2>One-line install</h2>
-      <pre>$ gem install gcloud</pre>
+      <pre>$ gem install google-cloud</pre>
       <h4 class="latest-release subtle" ng-if="home.latestRelease">
         Latest Release <a ng-href="{{home.latestRelease.link}}" class="latest-release--link white">{{home.latestRelease.name}}</a>
         {{home.latestRelease.date|date}}

diff --git a/google-cloud-bigquery/README.md b/google-cloud-bigquery/README.md
@@ -1,11 +1,17 @@
 # google-cloud-bigquery
 
-Google Cloud BigQuery enables super-fast, SQL-like queries against massive
-datasets, using the processing power of Google's infrastructure.
+[Google Cloud BigQuery](https://cloud.google.com/bigquery/) ([docs](https://cloud.google.com/bigquery/docs)) enables super-fast, SQL-like queries against append-only tables, using the processing power of Google's infrastructure. Simply move your data into BigQuery and let it handle the hard work. You can control access to both the project and your data based on your business needs, such as giving others the ability to view or query your data.
 
 - [google-cloud-bigquery API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-bigquery/google/cloud/bigquery)
+- [google-cloud-bigquery on RubyGems](https://rubygems.org/gems/google-cloud-bigquery)
 - [Google Cloud BigQuery documentation](https://cloud.google.com/bigquery/docs)
 
+## Quick Start
+
+```sh
+$ gem install google-cloud-bigquery
+```
+
 ## Authentication
 
 This library uses Service Account credentials to connect to Google Cloud services. When running on Compute Engine the credentials will be discovered automatically. When running on other environments the Service Account credentials can be specified by providing the path to the JSON file, or the JSON itself, in environment variables.

diff --git a/google-cloud-datastore/README.md b/google-cloud-datastore/README.md
@@ -1,14 +1,18 @@
 # google-cloud-datastore
 
-Google Cloud Datastore is a fully managed, schemaless database for storing
-non-relational data. You should feel at home if you are familiar with
-relational databases, but there are some key differences to be aware of to
-make the most of using Datastore.
+[Google Cloud Datastore](https://cloud.google.com/datastore/) ([docs](https://cloud.google.com/datastore/docs)) is a fully managed, schemaless database for storing non-relational data. Cloud Datastore automatically scales with your users and supports ACID transactions, high availability of reads and writes, strong consistency for reads and ancestor queries, and eventual consistency for all other queries.
+
+Follow the [activation instructions](https://cloud.google.com/datastore/docs/activate) to use the Google Cloud Datastore API with your project.
 
 - [google-cloud-datastore API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-datastore/google/cloud/datastore)
+- [google-cloud-datastore on RubyGems](https://rubygems.org/gems/google-cloud-datastore)
 - [Google Cloud Datastore documentation](https://cloud.google.com/datastore/docs)
 
-*Follow the [activation instructions](https://cloud.google.com/datastore/docs/activate) to use the Google Cloud Datastore API with your project.*
+## Quick Start
+
+```sh
+$ gem install google-cloud-datastore
+```
 
 ## Authentication
 

diff --git a/google-cloud-dns/README.md b/google-cloud-dns/README.md
@@ -1,15 +1,17 @@
 # google-cloud-dns
 
-Google Cloud DNS is a high-performance, resilient, global DNS service that
-provides a cost-effective way to make your applications and services
-available to your users. This programmable, authoritative DNS service can
-be used to easily publish and manage DNS records using the same
-infrastructure relied upon by Google. To learn more, read [What is Google
-Cloud DNS?](https://cloud.google.com/dns/what-is-cloud-dns).
+[Google Cloud DNS](https://cloud.google.com/dns/) ([docs](https://cloud.google.com/dns/docs)) is a high-performance, resilient, global DNS service that provides a cost-effective way to make your applications and services available to your users. This programmable, authoritative DNS service can be used to easily publish and manage DNS records using the same infrastructure relied upon by Google. To learn more, read [What is Google Cloud DNS?](https://cloud.google.com/dns/what-is-cloud-dns).
 
 - [google-cloud-dns API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-dns/google/cloud/dns)
+- [google-cloud-dns on RubyGems](https://rubygems.org/gems/google-cloud-dns)
 - [Google Cloud DNS documentation](https://cloud.google.com/dns/docs)
 
+## Quick Start
+
+```sh
+$ gem install google-cloud-dns
+```
+
 ## Authentication
 
 This library uses Service Account credentials to connect to Google Cloud services. When running on Compute Engine the credentials will be discovered automatically. When running on other environments the Service Account credentials can be specified by providing the path to the JSON file, or the JSON itself, in environment variables.

diff --git a/google-cloud-logging/README.md b/google-cloud-logging/README.md
@@ -1,22 +1,17 @@
 # google-cloud-logging
 
-The Stackdriver Logging service collects and stores logs from applications
-and services on the Google Cloud Platform, giving you fine-grained,
-programmatic control over your projects' logs. You can use the Stackdriver
-Logging API to:
-
-* [Read and filter log entries](#listing-log-entries)
-* [Export your log entries](#exporting-log-entries) to Cloud Storage,
-  BigQuery, or Cloud Pub/Sub
-* [Create logs-based metrics](#creating-logs-based-metrics) for use in
-  Cloud Monitoring
-* [Write log entries](#writing-log-entries)
-
-## Resources
+[Stackdriver Logging](https://cloud.google.com/logging/) ([docs](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). It supports ingestion of any custom log data from any source. Stackdriver Logging is a fully-managed service that performs at scale and can ingest application and system log data from thousands of VMs. Even better, you can analyze all that log data in real-time.
 
 - [google-cloud-logging API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-logging/google/cloud/logging)
+- [google-cloud-logging on RubyGems](https://rubygems.org/gems/google-cloud-logging)
 - [Stackdriver Logging documentation](https://cloud.google.com/logging/docs/)
 
+## Quick Start
+
+```sh
+$ gem install google-cloud-logging
+```
+
 ## Authentication
 
 This library uses Service Account credentials to connect to Google Cloud services. When running on Compute Engine the credentials will be discovered automatically. When running on other environments the Service Account credentials can be specified by providing the path to the JSON file, or the JSON itself, in environment variables.

diff --git a/google-cloud-pubsub/README.md b/google-cloud-pubsub/README.md
@@ -1,15 +1,17 @@
 # google-cloud-pubsub
 
-Google Cloud Pub/Sub is designed to provide reliable, many-to-many,
-asynchronous messaging between applications. Publisher applications can
-send messages to a "topic" and other applications can subscribe to that
-topic to receive the messages. By decoupling senders and receivers, Google
-Cloud Pub/Sub allows developers to communicate between independently
-written applications.
+[Google Cloud Pub/Sub](https://cloud.google.com/pubsub/) ([docs](https://cloud.google.com/pubsub/reference/rest/)) is designed to provide reliable, many-to-many, asynchronous messaging between applications. Publisher applications can send messages to a “topic” and other applications can subscribe to that topic to receive the messages. By decoupling senders and receivers, Google Cloud Pub/Sub allows developers to communicate between independently written applications.
 
 - [google-cloud-pubsub API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-pubsub/google/cloud/pubsub)
+- [[google-cloud-pubsub on RubyGems](https://rubygems.org/gems/[google-cloud-pubsub)
 - [Google Cloud Pub/Sub documentation](https://cloud.google.com/pubsub/docs)
 
+## Quick Start
+
+```sh
+$ gem install google-cloud-pubsub
+```
+
 ## Authentication
 
 This library uses Service Account credentials to connect to Google Cloud services. When running on Compute Engine the credentials will be discovered automatically. When running on other environments the Service Account credentials can be specified by providing the path to the JSON file, or the JSON itself, in environment variables.

diff --git a/google-cloud-resource_manager/README.md b/google-cloud-resource_manager/README.md
@@ -1,21 +1,18 @@
 # google-cloud-resource_manager
 
-The Resource Manager API provides methods that you can use to
-programmatically manage your projects in the Google Cloud Platform. You
-may be familiar with managing projects in the [Developers
-Console](https://developers.google.com/console/help/new/). With this API
-you can do the following:
+[Google Cloud Resource Manager](https://cloud.google.com/resource-manager/) ([docs](https://cloud.google.com/resource-manager/reference/rest/)) enables you to
+programmatically manage  container resources such as Organizations and Projects, that allow you to group and hierarchically organize other Cloud Platform resources. This hierarchical organization lets you easily manage common aspects of your resources such as access control and configuration settings. You may be familiar with managing projects in the [Developers Console](https://developers.google.com/console/help/new/). With this API you can do the following:
 
 * Get a list of all projects associated with an account
 * Create new projects
 * Update existing projects
 * Delete projects
 * Undelete, or recover, projects that you don't want to delete
 
-The Resource Manager API is a Beta release and is not covered by any SLA
-or deprecation policy and may be subject to backward-incompatible changes.
+The Resource Manager API is a Beta release and is not covered by any SLA or deprecation policy and may be subject to backward-incompatible changes.
 
 - [google-cloud-resource_manager API documentation](http://googlecloudplatform.github.io/gcloud-ruby/#/docs/google-cloud-resource_manager/google/cloud/resourcemanager)
+- [google-cloud-resource_manager on RubyGems](https://rubygems.org/gems/google-cloud-resource_manager)
 - [Google Cloud Resource Manager documentation](https://cloud.google.com/resource-manager/)
 
 ## Accessing the Service
@@ -28,6 +25,12 @@ methods such as {ResourceManager::Manager#projects} and
 the Resource Manager API in the [Developers
 Console](https://console.developers.google.com).
 
+## Quick Start
+
+```sh
+$ gem install google-cloud-resource_manager
+```
+
 ## Authentication
 
 The Resource Manager API currently requires authentication of a [User