Skip to content

Commit ecb2c28

Browse files
yoshi-automationJustinBeckwith
authored andcommitted
build: check for 404s in the docs (#1562)
1 parent d49aa49 commit ecb2c28

File tree

5 files changed

+18
-5
lines changed

5 files changed

+18
-5
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Thanks for stopping by to let us know something could be better!
1010

1111
Please run down the following list and make sure you've tried the usual "quick fixes":
1212

13-
- Search the issues already opened: https://github.com/google/google-api-nodejs-client/issues
13+
- Search the issues already opened: https://github.com/googleapis/google-api-nodejs-client/issues
1414
- Search the issues on our "catch-all" repository: https://github.com/googleapis/google-cloud-node
1515
- Search StackOverflow: http://stackoverflow.com/questions/tagged/google-cloud-platform+node.js
1616

.jsdoc.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ module.exports = {
2020
opts: {
2121
readme: './README.md',
2222
package: './package.json',
23-
template: './node_modules/ink-docstrap/template',
23+
template: './node_modules/jsdoc-baseline',
2424
recurse: true,
2525
verbose: true,
2626
destination: './docs/'

.kokoro/docs.sh

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,11 @@ cd $(dirname $0)/..
2323
npm install
2424

2525
npm run docs
26+
27+
# Check broken links
28+
BIN=./node_modules/.bin
29+
30+
npm install broken-link-checker
31+
npm install http-server
32+
$BIN/http-server -p 8080 docs/ &
33+
$BIN/blc -r http://localhost:8080

src/generator/docs.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,12 @@ const writeFile = promisify(fs.writeFile);
2626
const srcPath = path.join(__dirname, '../../../src');
2727
const apiPath = path.join(srcPath, 'apis');
2828
const templatePath = path.join(srcPath, 'generator/templates/index.html.njk');
29-
const indexPath = path.join(__dirname, '../../../docs/index.html');
29+
const docsPath = path.join(__dirname, '../../../docs');
30+
const indexPath = path.join(docsPath, 'index.html');
31+
32+
if (!fs.existsSync(docsPath)) {
33+
fs.mkdirSync(docsPath);
34+
}
3035

3136
/**
3237
* Iterate over each API directory, and use the `compodoc` tool to generate

synth.metadata

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
2-
"updateTime": "2018-12-12T12:06:29.527675Z",
2+
"updateTime": "2019-01-22T12:06:08.587628Z",
33
"sources": [
44
{
55
"template": {
66
"name": "node_library",
77
"origin": "synthtool.gcp",
8-
"version": "2018.12.6"
8+
"version": "2019.1.16"
99
}
1010
}
1111
]

0 commit comments

Comments
 (0)