build: check broken links in generated docs (#248)

googleapis · Jan 14, 2019 · 225544e · 225544e
1 parent 1e5ff34
commit 225544e
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 7 deletions.
diff --git a/packages/google-cloud-compute/.jsdoc.js b/packages/google-cloud-compute/.jsdoc.js
@@ -20,7 +20,7 @@ module.exports = {
   opts: {
     readme: './README.md',
     package: './package.json',
-    template: './node_modules/ink-docstrap/template',
+    template: './node_modules/jsdoc-baseline',
     recurse: true,
     verbose: true,
     destination: './docs/'

diff --git a/packages/google-cloud-compute/README.md b/packages/google-cloud-compute/README.md
@@ -97,7 +97,7 @@ has instructions for running the samples.
 
 | Sample                      | Source Code                       | Try it |
 | --------------------------- | --------------------------------- | ------ |
-| Create Virtual Machine with Apache and Custom Homepage | [source code](https://github.com/googleapis/nodejs-compute/blob/master/samples/startup-script/index.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-compute&page=editor&open_in_editor=samples/startup-script/index.js,samples/README.md) |
+| Create Virtual Machine with Apache and Custom Homepage | [source code](https://github.com/googleapis/nodejs-compute/blob/master/samples/startupScript.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-compute&page=editor&open_in_editor=samples/startupScript.js,samples/README.md) |
 | List Virtual Machines | [source code](https://github.com/googleapis/nodejs-compute/blob/master/samples/vms.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-compute&page=editor&open_in_editor=samples/vms.js,samples/README.md) |
 
 The [Compute Engine Node.js Client API Reference][client-docs] documentation

diff --git a/packages/google-cloud-compute/package.json b/packages/google-cloud-compute/package.json
@@ -55,7 +55,7 @@
     "eslint-config-prettier": "^3.0.0",
     "eslint-plugin-node": "^8.0.0",
     "eslint-plugin-prettier": "^3.0.0",
-    "ink-docstrap": "^1.3.2",
+    "jsdoc-baseline": "git+https://github.com/hegemonic/jsdoc-baseline.git",
     "intelli-espower-loader": "^1.0.1",
     "jsdoc": "^3.5.5",
     "mocha": "^5.2.0",

diff --git a/packages/google-cloud-compute/samples/.eslintrc.yml b/packages/google-cloud-compute/samples/.eslintrc.yml
@@ -1,3 +1,4 @@
 ---
 rules:
   no-console: off
+  node/no-missing-require: off
diff --git a/packages/google-cloud-compute/src/image.js b/packages/google-cloud-compute/src/image.js
@@ -120,7 +120,7 @@ class Image extends common.ServiceObject {
       /**
        * Get the image's metadata.
        *
-       * @see [Images: get API Documentation]{@link https://cloud.google.com/compute/docs/reference/v1/image/get}
+       * @see [Images: get API Documentation]{@link https://cloud.google.com/compute/docs/reference/v1/images/get}
        * @see [Image Resource]{@link https://cloud.google.com/compute/docs/reference/v1/images}
        *
        * @method Image#getMetadata

diff --git a/packages/google-cloud-compute/src/instance-group.js b/packages/google-cloud-compute/src/instance-group.js
@@ -28,7 +28,7 @@ const {teenyRequest} = require('teeny-request');
  * don't have to individually control each instance in your project.
  *
  * @see [Creating Groups of Instances]{@link https://cloud.google.com/compute/docs/instance-groups}
- * @see [Unmanaged Instance Groups]{@link https://cloud.google.com/compute/docs/instance-groups/unmanaged-groups}
+ * @see [Unmanaged Instance Groups]{@link https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-unmanaged-instances}
  *
  * @class
  * @param {Zone} zone

diff --git a/packages/google-cloud-compute/src/subnetwork.js b/packages/google-cloud-compute/src/subnetwork.js
@@ -135,8 +135,8 @@ class Subnetwork extends common.ServiceObject {
       /**
        * Get the metadata of this subnetwork.
        *
-       * @see [Subnetwork Resource]{@link https://cloud.google.com/compute/docs/reference/v1/subnetwork}
-       * @see [Subnetwork: get API Documentation]{@link https://cloud.google.com/compute/docs/reference/v1/subnetwork/get}
+       * @see [Subnetwork Resource]{@link https://cloud.google.com/compute/docs/reference/v1/subnetworks}
+       * @see [Subnetwork: get API Documentation]{@link https://cloud.google.com/compute/docs/reference/v1/subnetworks/get}
        *
        * @method Subnetwork#getMetadata
        * @param {function=} callback - The callback function.