docs: fix bad links (#3783)

googleapis · Aug 14, 2019 · 3ed56b3 · 3ed56b3
1 parent 16c3bc2
commit 3ed56b3
Show file tree

Hide file tree

Showing 17 changed files with 110 additions and 58 deletions.
diff --git a/AUTHENTICATION.md b/AUTHENTICATION.md
@@ -18,15 +18,51 @@ 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.
 
+[dev-console]: https://console.cloud.google.com/project
+
+[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
+
+[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
+[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
+[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
+
 ## Creating a Service Account
 
 Google Cloud requires a **Project ID** and **Service Account Credentials** to
-connect to the APIs. For detailed instructions on how to create a service
-account, see the [Authentication
-guide](docs/google-cloud/v0.12.2/guides/authentication#onyourownserver).
+connect to most services.
+
+If you are not running this client within [Google Cloud Platform
+environments](#google-cloud-platform-environments), you need a Google
+Developers service account.
+
+1. Visit the [Google Developers Console][dev-console].
+1. Create a new project or click on an existing project.
+1. Activate the slide-out navigation tray and select **API Manager**. From
+   here, you will enable the APIs that your application requires.
+
+   ![Enable the APIs that your application requires][enable-apis]
+
+   *Note: You may need to enable billing in order to use these services.*
+
+1. Select **Credentials** from the side navigation.
+
+   You should see a screen like one of the following.
+
+   ![Create a new service account][create-new-service-account]
+
+   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
+
+   Find the "Add credentials" drop down and select "Service account" to be
+   guided through downloading a new JSON key file.
+
+   If you want to re-use an existing service account, you can easily generate a
+   new key file. Just select the account you wish to re-use, and click "Generate
+   new JSON key":
+
+   ![Re-use an existing service account][reuse-service-account]
 
-You will use the **Project ID** and **JSON key file** to connect to most
-services with google-cloud-ruby.
+   The key file you download will be used to authenticate API
+   requests and should be stored in a secure location.
 
 ## Project and Credential Lookup
 

diff --git a/README.md b/README.md
@@ -3,7 +3,6 @@
 Idiomatic Ruby client for [Google Cloud Platform](https://cloud.google.com/)
 services.
 
-[![CircleCI Build Status](https://circleci.com/gh/googleapis/google-cloud-ruby.svg?&style=shield)](https://circleci.com/gh/googleapis/google-cloud-ruby)
 [![Coverage Status](https://codecov.io/gh/googleapis/google-cloud-ruby/branch/master/graph/badge.svg)](https://codecov.io/gh/googleapis/google-cloud-ruby)
 [![Gem Version](https://badge.fury.io/rb/google-cloud.svg)](http://badge.fury.io/rb/google-cloud)
 
@@ -864,7 +863,7 @@ $ gem install google-cloud-scheduler
   to see the full list of Cloud APIs that we cover.
 
 [Client Library Documentation]: https://googleapis.dev/ruby/google-cloud-scheduler/latest
-[Product Documentation]: https://cloud.google.com/cloudscheduler
+[Product Documentation]: https://cloud.google.com/scheduler
 
 ## Enabling Logging
 

diff --git a/RELEASING.md b/RELEASING.md
@@ -102,7 +102,7 @@ green, you may create a release as follows:
    gem, repeat steps 4 through 12 for the `stackdriver` gem.
 
 1. After your pull request has passed all checks and been approved by reviewers,
-   **Squash and merge** it. Do **not** delete the branch. [Kokoro](#checking-the-status-of-kokoro-builds) will create the [GitHub release summary](https://github.com/googleapis/google-cloud-ruby/releases) and build and push the gem to [rubygems](https://rubygems.org/). If yoshi-automation reports a failure creating the [GitHub release summary](https://github.com/googleapis/google-cloud-ruby/releases), file a bug on [releasetool's issue tracker](https://github.com/googleapis/releasetool/issues), and [write the release manually](writing-a-github-release-summary-manually). If yoshi-automation reports that the release build has failed, follow [these steps](#checking-the-status-of-kokoro-builds), selecting the Kokoro build titled "Kokoro - Release".
+   **Squash and merge** it. Do **not** delete the branch. [Kokoro](#checking-the-status-of-kokoro-builds) will create the [GitHub release summary](https://github.com/googleapis/google-cloud-ruby/releases) and build and push the gem to [rubygems](https://rubygems.org/). If yoshi-automation reports a failure creating the [GitHub release summary](https://github.com/googleapis/google-cloud-ruby/releases), file a bug on [releasetool's issue tracker](https://github.com/googleapis/releasetool/issues), and [write the release manually](#writing-a-github-release-summary-manually). If yoshi-automation reports that the release build has failed, follow [these steps](#checking-the-status-of-kokoro-builds), selecting the Kokoro build titled "Kokoro - Release".
 
 1. If everything has gone successfully, [yoshi-automation](https://github.com/yoshi-automation) will post twice on the merged PR. Once to provide the status and link for the [GitHub release summary](https://github.com/googleapis/google-cloud-ruby/releases), and again to provide the status of the task to publish to [rubygems](https://rubygems.org/). At this point, please delete the branch created by releasetool in step 11(iv).
 

diff --git a/Rakefile b/Rakefile
@@ -599,7 +599,7 @@ namespace :kokoro do
       broken_markdown_links[file] += checked_links unless checked_links.empty?
     end
     gems.each do |gem|
-      out, err, st = Open3.capture3 "npx linkinator #{devsite_base}#{gem}/latest --recurse --skip https:.*github.*"
+      out, err, st = Open3.capture3 "npx linkinator #{devsite_base}#{gem}/latest/ --recurse --skip https:.*github.*"
       puts out
       exit_status = [exit_status, st.to_i].max
       puts err unless st.to_i.zero?

diff --git a/gcloud/README.md b/gcloud/README.md
@@ -9,7 +9,7 @@ repository](https://github.com/googleapis/google-cloud-ruby) for more
 information about using the `google-cloud` umbrella gem and the individual
 service gems.
 
-- [gcloud API documentation](https://googleapis.dev/ruby/docs/gcloud/latest)
+- [gcloud API documentation](https://googleapis.dev/ruby/gcloud/latest)
 - [gcloud on RubyGems](https://rubygems.org/gems/gcloud)
 
 ## Quick Start

diff --git a/google-cloud-asset/synth.py b/google-cloud-asset/synth.py
@@ -231,5 +231,11 @@ def escape_braces(match):
     'dev/ruby/google-cloud-asset/latest'
 )
 
+s.replace(
+    ['lib/**/*.rb', 'README.md'],
+    'https://cloud.google.com/asset',
+    'https://cloud.google.com/resource-manager'
+)
+
 # Generate the helper methods
 call('bundle update && bundle exec rake generate', shell=True)
diff --git a/google-cloud-bigquery/OVERVIEW.md b/google-cloud-bigquery/OVERVIEW.md
@@ -87,7 +87,7 @@ advantages over legacy SQL, including:
 * Complex `JOIN` predicates, including arbitrary expressions
 
 For examples that demonstrate some of these features, see [Standard SQL
-ghlights](https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-l#standard_sql_highlights).
+ghlights](https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#standard_sql_highlights).
 
 As shown in this example, standard SQL is the library default:
 

diff --git a/google-cloud-bigtable/samples/README.md b/google-cloud-bigtable/samples/README.md
@@ -11,10 +11,9 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-
 - [Before you begin](#before-you-begin)
 - [Samples](#samples)
-  - [Hello World](#hello-world)
+  - [Quickstart](#quickstart)
   - [Instances](#instances)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -58,11 +57,6 @@ Expected output similar to:
    @key="row-1">
 ```
 
-### Hello World
-
-View the [Hello World][hello_world_directory] sample to see a basic usage of
-the Bigtable client library.
-
 ### Instances
 
 View the [source code][instances_0_code].
@@ -123,10 +117,9 @@ Examples:
 
 For more information, see https://cloud.google.com/bigtable/docs
 ```
+
 [instances_0_docs]: https://cloud.google.com/bigtable/docs/
 [instances_0_code]: instances.rb
 
-[hello_world_directory]: hello-world
-
 [shell_img]: //gstatic.com/cloudssh/images/open-btn.png
 [shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-ruby&page=editor&open_in_editor=google-cloud-bigtable/samples/README.md
diff --git a/google-cloud-error_reporting/INSTRUMENTATION.md b/google-cloud-error_reporting/INSTRUMENTATION.md
@@ -26,7 +26,7 @@ you want to run on a non Google Cloud environment or you want to customize  the
 default behavior.
 
 See the [Configuration
-Guide](https://googleapis.dev/ruby/stackdriver/INSTRUMENTATION_CONFIGURATION/latest)
+Guide](https://googleapis.dev/ruby/stackdriver/latest/file.INSTRUMENTATION_CONFIGURATION.html)
 for full configuration parameters.
 
 ## Rack Middleware and Railtie
@@ -48,7 +48,7 @@ require "google/cloud/error_reporting/rails"
 ```
 
 Alternatively, check out the
-[stackdriver](https://googleapis.dev/ruby/stackdriver/latest/file.README.html
+[stackdriver](https://googleapis.dev/ruby/stackdriver/latest
 gem, which enables this Railtie by default.
 
 ### Rack Integration

diff --git a/google-cloud-error_reporting/README.md b/google-cloud-error_reporting/README.md
@@ -35,7 +35,7 @@ $ bundle install
 ```
 
 Alternatively, check out the
-[`stackdriver`](https://googleapis.dev/ruby/stackdriver/latest/file.README.html
+[`stackdriver`](https://googleapis.dev/ruby/stackdriver)
 gem that includes the `google-cloud-error_reporting` gem.
 
 ## Enable Stackdriver Error Reporting API
@@ -92,7 +92,7 @@ end
 
 You can customize the behavior of the Stackdriver Error Reporting library for
 Ruby. See the [configuration
-guide](https://googleapis.dev/ruby/stackdriver/INSTRUMENTATION_CONFIGURATION/latest)
+guide](https://googleapis.dev/ruby/stackdriver/latest/file.INSTRUMENTATION_CONFIGURATION.html)
 for a list of possible configuration options.
 
 ## Running on Google Cloud Platform

diff --git a/google-cloud-phishing_protection/synth.py b/google-cloud-phishing_protection/synth.py
@@ -256,5 +256,11 @@ def escape_braces(match):
     'dev/ruby/google-cloud-phishing_protection/latest'
 )
 
+s.replace(
+    'README.md',
+    'https://cloud.google.com/phishingprotection',
+    'https://cloud.google.com/phishing-protection'
+)
+
 # Generate the helper methods
 call('bundle update && bundle exec rake generate_partials', shell=True)
diff --git a/google-cloud-recaptcha_enterprise/synth.py b/google-cloud-recaptcha_enterprise/synth.py
@@ -250,5 +250,11 @@ def escape_braces(match):
     'dev/ruby/google-cloud-recaptcha_enterprise/latest'
 )
 
+s.replace(
+    'README.md',
+    'https://cloud.google.com/recaptchaenterprise',
+    'https://cloud.google.com/recaptcha-enterprise'
+)
+
 # Generate the helper methods
 call('bundle update && bundle exec rake generate_partials', shell=True)
diff --git a/google-cloud-scheduler/synth.py b/google-cloud-scheduler/synth.py
@@ -202,5 +202,11 @@
     'dev/ruby/google-cloud-scheduler/latest'
 )
 
+s.replace(
+    ['lib/**/*.rb', 'README.md'],
+    'https://cloud.google.com/cloudscheduler',
+    'https://cloud.google.com/scheduler'
+)
+
 # Generate the helper methods
 call('bundle update && bundle exec rake generate_partials', shell=True)
diff --git a/google-cloud-spanner/OVERVIEW.md b/google-cloud-spanner/OVERVIEW.md
@@ -21,7 +21,7 @@ When you first use Cloud Spanner, you must create an instance, which is an
 allocation of resources that are used by Cloud Spanner databases. When you
 create an instance, you choose where your data is stored and how many nodes are
 used for your data. (For more information, see [Configuration
-Guide](https://googleapis.dev/ruby/stackdriver/INSTRUMENTATION_CONFIGURATION)/latest).
+Guide](https://googleapis.dev/ruby/stackdriver/latest/file.INSTRUMENTATION_CONFIGURATION.html).
 
 Use {Google::Cloud::Spanner::Project#create_instance Project#create_instance} to
 create an instance:

diff --git a/google-cloud-trace/INSTRUMENTATION.md b/google-cloud-trace/INSTRUMENTATION.md
@@ -16,7 +16,7 @@ you want to run on a non Google Cloud environment or you want to customize  the
 default behavior.
 
 See the [Configuration
-Guide](https://googleapis.dev/ruby/stackdriver/INSTRUMENTATION_CONFIGURATION/latest)
+Guide](https://googleapis.dev/ruby/stackdriver/latest/file.INSTRUMENTATION_CONFIGURATION.html)
 for full configuration parameters.
 
 ## Rails Integration
@@ -29,7 +29,7 @@ require "google/cloud/trace/rails"
 ```
 
 Alternatively, check out the
-[stackdriver](https://googleapis.dev/ruby/stackdriver/latest/file.README.html)
+[stackdriver](https://googleapis.dev/ruby/stackdriver/latest)
 gem, which enables this Railtie by default.
 
 ## Rack Integration

diff --git a/google-cloud/README.md b/google-cloud/README.md
@@ -14,36 +14,36 @@ individual google-cloud-* gems that you need.
 
 This gem depends on and lazily loads the following google-cloud-* gems:
 
-- [google-cloud-asset](https://github.com/googleapis/google-cloud-ruby/google-cloud-asset
-- [google-cloud-bigquery](https://github.com/googleapis/google-cloud-ruby/google-cloud-bigquery
-- [google-cloud-bigquery-data_transfer](https://github.com/googleapis/google-cloud-ruby/google-cloud-bigquery-data_transfer
-- [google-cloud-bigtable](https://github.com/googleapis/google-cloud-ruby/google-cloud-bigtable
-- [google-cloud-container](https://github.com/googleapis/google-cloud-ruby/google-cloud-container
-- [google-cloud-dataproc](https://github.com/googleapis/google-cloud-ruby/google-cloud-dataproc
-- [google-cloud-datastore](https://github.com/googleapis/google-cloud-ruby/google-cloud-datastore
-- [google-cloud-dialogflow](https://github.com/googleapis/google-cloud-ruby/google-cloud-dialogflow
-- [google-cloud-dlp](https://github.com/googleapis/google-cloud-ruby/google-cloud-dlp
-- [google-cloud-dns](https://github.com/googleapis/google-cloud-ruby/google-cloud-dns
-- [google-cloud-error_reporting](https://github.com/googleapis/google-cloud-ruby/google-cloud-error_reporting
-- [google-cloud-firestore](https://github.com/googleapis/google-cloud-ruby/google-cloud-firestore
-- [google-cloud-kms](https://github.com/googleapis/google-cloud-ruby/google-cloud-kms
-- [google-cloud-language](https://github.com/googleapis/google-cloud-ruby/google-cloud-language
-- [google-cloud-logging](https://github.com/googleapis/google-cloud-ruby/google-cloud-logging
-- [google-cloud-monitoring](https://github.com/googleapis/google-cloud-ruby/google-cloud-monitoring
-- [google-cloud-os_login](https://github.com/googleapis/google-cloud-ruby/google-cloud-os_login
-- [google-cloud-pubsub](https://github.com/googleapis/google-cloud-ruby/google-cloud-pubsub
-- [google-cloud-redis](https://github.com/googleapis/google-cloud-ruby/google-cloud-redis
-- [google-cloud-resource_manager](https://github.com/googleapis/google-cloud-ruby/google-cloud-resource_manager
-- [google-cloud-scheduler](https://github.com/googleapis/google-cloud-ruby/google-cloud-scheduler
-- [google-cloud-spanner](https://github.com/googleapis/google-cloud-ruby/google-cloud-spanner
-- [google-cloud-speech](https://github.com/googleapis/google-cloud-ruby/google-cloud-speech
-- [google-cloud-storage](https://github.com/googleapis/google-cloud-ruby/google-cloud-storage
-- [google-cloud-tasks](https://github.com/googleapis/google-cloud-ruby/google-cloud-tasks
-- [google-cloud-text_to_speech](https://github.com/googleapis/google-cloud-ruby/google-cloud-text_to_speech
-- [google-cloud-trace](https://github.com/googleapis/google-cloud-ruby/google-cloud-trace
-- [google-cloud-translate](https://github.com/googleapis/google-cloud-ruby/google-cloud-translate
-- [google-cloud-video_intelligence](https://github.com/googleapis/google-cloud-ruby/google-cloud-video_intelligence
-- [google-cloud-vision](https://github.com/googleapis/google-cloud-ruby/google-cloud-vision
+- [google-cloud-asset](https://googleapis.dev/ruby/google-cloud-asset/latest
+- [google-cloud-bigquery](https://googleapis.dev/ruby/google-cloud-bigquery/latest
+- [google-cloud-bigquery-data_transfer](https://googleapis.dev/ruby/google-cloud-bigquery-data_transfer/latest
+- [google-cloud-bigtable](https://googleapis.dev/ruby/google-cloud-bigtable/latest
+- [google-cloud-container](https://googleapis.dev/ruby/google-cloud-container/latest
+- [google-cloud-dataproc](https://googleapis.dev/ruby/google-cloud-dataproc/latest
+- [google-cloud-datastore](https://googleapis.dev/ruby/google-cloud-datastore/latest
+- [google-cloud-dialogflow](https://googleapis.dev/ruby/google-cloud-dialogflow/latest
+- [google-cloud-dlp](https://googleapis.dev/ruby/google-cloud-dlp/latest
+- [google-cloud-dns](https://googleapis.dev/ruby/google-cloud-dns/latest
+- [google-cloud-error_reporting](https://googleapis.dev/ruby/google-cloud-error_reporting/latest
+- [google-cloud-firestore](https://googleapis.dev/ruby/google-cloud-firestore/latest
+- [google-cloud-kms](https://googleapis.dev/ruby/google-cloud-kms/latest
+- [google-cloud-language](https://googleapis.dev/ruby/google-cloud-language/latest
+- [google-cloud-logging](https://googleapis.dev/ruby/google-cloud-logging/latest
+- [google-cloud-monitoring](https://googleapis.dev/ruby/google-cloud-monitoring/latest
+- [google-cloud-os_login](https://googleapis.dev/ruby/google-cloud-os_login/latest
+- [google-cloud-pubsub](https://googleapis.dev/ruby/google-cloud-pubsub/latest
+- [google-cloud-redis](https://googleapis.dev/ruby/google-cloud-redis/latest
+- [google-cloud-resource_manager](https://googleapis.dev/ruby/google-cloud-resource_manager/latest
+- [google-cloud-scheduler](https://googleapis.dev/ruby/google-cloud-scheduler/latest
+- [google-cloud-spanner](https://googleapis.dev/ruby/google-cloud-spanner/latest
+- [google-cloud-speech](https://googleapis.dev/ruby/google-cloud-speech/latest
+- [google-cloud-storage](https://googleapis.dev/ruby/google-cloud-storage/latest
+- [google-cloud-tasks](https://googleapis.dev/ruby/google-cloud-tasks/latest
+- [google-cloud-text_to_speech](https://googleapis.dev/ruby/google-cloud-text_to_speech/latest
+- [google-cloud-trace](https://googleapis.dev/ruby/google-cloud-trace/latest
+- [google-cloud-translate](https://googleapis.dev/ruby/google-cloud-translate/latest
+- [google-cloud-video_intelligence](https://googleapis.dev/ruby/google-cloud-video_intelligence/latest
+- [google-cloud-vision](https://googleapis.dev/ruby/google-cloud-vision/latest
 
 ## Quick Start
 

diff --git a/integration/README.md b/integration/README.md
@@ -44,7 +44,7 @@ $ rake integration:gae
 ```
 This rake task automates the Google App Engine deployment by deploying the google-cloud-ruby libraries with sample applications using the `gcloud app deploy` shell command. Each of the sample applications contains an app.yaml.example file that defines specific deployment procedure for that application. For example, the [Rails 5 app.yaml.example](rails5_app/app.yaml.example) file defines a custom entrypoint that allows bundler to install the sample application's dependencies and launch the application.
 
-After a successful deployment, each google-cloud-ruby libraries can then run its integration tests against the deployed sample application. For example, the [google-cloud-logging tests](google-cloud-logging/integration/) send HTTP requests to redefined routes on the sample application to trigger logs being generated. Then it's able to verify the result logs through Cloud SDK. 
+After a successful deployment, each google-cloud-ruby libraries can then run its integration tests against the deployed sample application. For example, the [google-cloud-logging tests](../google-cloud-logging/integration/) send HTTP requests to redefined routes on the sample application to trigger logs being generated. Then it's able to verify the result logs through Cloud SDK. 
 
 ### Integration tests on Google Container Engine
 To run the integration tests on Google Container Engine: