From 2d6dfa7471ade3a413564069f631425d038d621b Mon Sep 17 00:00:00 2001 From: Jonathan Lui Date: Tue, 15 Jan 2019 10:20:51 -0800 Subject: [PATCH] build: check broken links in generated docs (#102) * build: check dead links on Kokoro * recursive crawl local links * add missing namespace * fix link in README.md * fix timestamp docs links --- packages/google-cloud-kms/.jsdoc.js | 2 +- packages/google-cloud-kms/README.md | 2 +- packages/google-cloud-kms/package.json | 2 +- packages/google-cloud-kms/src/index.js | 3 +++ .../src/v1/doc/google/protobuf/doc_timestamp.js | 6 ++---- packages/google-cloud-kms/synth.py | 11 +++++++++++ 6 files changed, 19 insertions(+), 7 deletions(-) diff --git a/packages/google-cloud-kms/.jsdoc.js b/packages/google-cloud-kms/.jsdoc.js index e93cc666c15..f7b164003d2 100644 --- a/packages/google-cloud-kms/.jsdoc.js +++ b/packages/google-cloud-kms/.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-kms/README.md b/packages/google-cloud-kms/README.md index f197a7839d1..9ee0cf0e725 100644 --- a/packages/google-cloud-kms/README.md +++ b/packages/google-cloud-kms/README.md @@ -68,7 +68,7 @@ has instructions for running the samples. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| KMS | [source code](https://github.com/googleapis/nodejs-kms/blob/master/samples/kms.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-kms&page=editor&open_in_editor=samples/kms.js,samples/README.md) | +| KMS | [source code](https://github.com/googleapis/nodejs-kms/blob/master/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-kms&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) | The [Cloud KMS Node.js Client API Reference][client-docs] documentation also contains samples. diff --git a/packages/google-cloud-kms/package.json b/packages/google-cloud-kms/package.json index aa15ff23991..11512ba620b 100644 --- a/packages/google-cloud-kms/package.json +++ b/packages/google-cloud-kms/package.json @@ -51,7 +51,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-kms/src/index.js b/packages/google-cloud-kms/src/index.js index ad25623fa0c..7b482efe2d6 100644 --- a/packages/google-cloud-kms/src/index.js +++ b/packages/google-cloud-kms/src/index.js @@ -24,6 +24,9 @@ /** * @namespace google.cloud.kms.v1 */ +/** + * @namespace google.protobuf + */ 'use strict'; diff --git a/packages/google-cloud-kms/src/v1/doc/google/protobuf/doc_timestamp.js b/packages/google-cloud-kms/src/v1/doc/google/protobuf/doc_timestamp.js index 1ebe2e6e1a5..1cc64cbed80 100644 --- a/packages/google-cloud-kms/src/v1/doc/google/protobuf/doc_timestamp.js +++ b/packages/google-cloud-kms/src/v1/doc/google/protobuf/doc_timestamp.js @@ -87,13 +87,11 @@ * 01:30 UTC on January 15, 2017. * * In JavaScript, one can convert a Date object to this format using the - * standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString] + * standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) * method. In Python, a standard `datetime.datetime` object can be converted * to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) * with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one - * can use the Joda Time's [`ISODateTimeFormat.dateTime()`](https://cloud.google.com - * http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime-- - * ) to obtain a formatter capable of generating timestamps in this format. + * can use the Joda Time's [`ISODateTimeFormat.dateTime()`](https://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime--) to obtain a formatter capable of generating timestamps in this format. * * @property {number} seconds * Represents seconds of UTC time since Unix epoch diff --git a/packages/google-cloud-kms/synth.py b/packages/google-cloud-kms/synth.py index 03bf4501bad..2beb360d019 100644 --- a/packages/google-cloud-kms/synth.py +++ b/packages/google-cloud-kms/synth.py @@ -37,6 +37,17 @@ templates = common_templates.node_library() s.copy(templates) +# [START fix-dead-link] +s.replace('**/doc/google/protobuf/doc_timestamp.js', + 'https:\/\/cloud\.google\.com[\s\*]*http:\/\/(.*)[\s\*]*\)', + r"https://\1)") + +s.replace('**/doc/google/protobuf/doc_timestamp.js', + 'toISOString\]', + 'toISOString)') +# [END fix-dead-link] + + # Node.js specific cleanup subprocess.run(['npm', 'install']) subprocess.run(['npm', 'run', 'fix'])