build: perform 404 scanning on docs (#2305)

Author: JustinBeckwith

.github/workflows/lint.yaml .github/workflows/ci.yaml

@@ -14,3 +14,10 @@ jobs:
           node-version: 14
       - run: npm install
       - run: npm run lint
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: JustinBeckwith/linkinator-action@v1
+        with:
+          paths: "**/*.md"

CONTRIBUTING.md

@@ -1,10 +1,10 @@
 # How to become a contributor and submit your own code
 
-This repository contains samples that the documentation on [Google Cloud Platform ][cloud] references. Samples for a client library should be added to the client repository, not this repository. (For example, the `functions` folder is reserved for samples used in [cloud.google.com/functions](cloud.google.com/functions)). If you wrote a great sample but it is not used in Google's official documentation, there are better suited places to publish it such as a [community tutorial](https://cloud.google.com/community/). 
+This repository contains samples that the documentation on [Google Cloud Platform ][cloud] references. Samples for a client library should be added to the client repository, not this repository. (For example, the `functions` folder is reserved for samples used in [cloud.google.com/functions](https://cloud.google.com/functions)). If you wrote a great sample but it is not used in Google's official documentation, there are better suited places to publish it such as a [community tutorial](https://cloud.google.com/community/).
 
 ## Run the tests for a single sample
 
-1. Obtain authentication credentials. Depending on the sample, you 
+1. Obtain authentication credentials. Depending on the sample, you
 need to enable the appropriate APIs in the [Cloud Console](https://console.cloud.google.com/apis/library).
 
         gcloud auth application-default login
@@ -13,7 +13,7 @@ need to enable the appropriate APIs in the [Cloud Console](https://console.cloud
 
         cd datastore/
 
-1. Install the dependencies. 
+1. Install the dependencies.
 
         npm install
 
@@ -24,11 +24,11 @@ need to enable the appropriate APIs in the [Cloud Console](https://console.cloud
 
 ## Adding new samples
 
-All samples must have tests. We use `mocha` as testing framework. 
+All samples must have tests. We use `mocha` as testing framework.
 
 Add a **build configuration file (`.cfg`)** for your samples in **[`.kokoro/`](https://github.com/GoogleCloudPlatform/nodejs-docs-samples/tree/master/.kokoro)**. Check existing config files for the right format.
 
-All tests need a corresponding job file outside of GitHub. If you are a Googler, please provide the CL alongside your PR. See the internal codelab for Kokoro for details. If you don't work at Google, the person reviewing your PR will create the job config for you. 
+All tests need a corresponding job file outside of GitHub. If you are a Googler, please provide the CL alongside your PR. See the internal codelab for Kokoro for details. If you don't work at Google, the person reviewing your PR will create the job config for you.
 
 ### Style
 
@@ -44,4 +44,4 @@ directory.
 [cloud]: https://cloud.google.com/
 
 ## Failing CI
-`Required` tests need to pass. Tests that are not required are expected to fail, they are usually work in progress. 
+`Required` tests need to pass. Tests that are not required are expected to fail, they are usually work in progress.

README.md

@@ -7,7 +7,7 @@ Node.js samples for [Google Cloud Platform products][cloud].
 See [cloud.google.com/nodejs][cloud_nodejs] to get up and running with Node.js
 on Google Cloud Platform.
 
-[slack_badge]: https://img.shields.io/badge/slack-Google%20Cloud%20Platform-E01563.svg	
+[slack_badge]: https://img.shields.io/badge/slack-Google%20Cloud%20Platform-E01563.svg
 [slack_link]: https://googlecloud-community.slack.com/
 [cloud]: https://cloud.google.com/
 [cloud_nodejs]: https://cloud.google.com/nodejs/
@@ -62,17 +62,6 @@ View the [tutorial][bookshelf_docs] or the [source code][bookshelf_code].
 [bookshelf_docs]: https://cloud.google.com/nodejs/getting-started/tutorial-app
 [bookshelf_code]: https://github.com/GoogleCloudPlatform/nodejs-getting-started
 
-### Node.js Codelab
-
-In the [Node.js Web App Google Cloud Platform][codelab_docs] codelab, you learn
-how to integrate Google Cloud Platform services into a Node.js web application
-to store data, upload images, and authenticate users.
-
-View the [tutorial][codelab_docs] or the [source code][codelab_code].
-
-[codelab_docs]: https://gcplab.me/codelabs/cloud-nodejs/index.html
-[codelab_code]: https://github.com/googlecodelabs/cloud-nodejs
-
 ## Contributing
 
 Contributions welcome! See the [Contributing Guide][contrib].

appengine/README.md

@@ -6,7 +6,7 @@ are referenced from the documentation on [cloud.google.com][appengine].
 
 There are also samples [submitted by the community][community_samples].
 
-See our other [Google Cloud Platform GitHub repositories](/GoogleCloudPlatform)
+See our other [Google Cloud Platform GitHub repositories](https://github.com/GoogleCloudPlatform)
 for sample applications and scaffolding for other frameworks and use cases.
 
 * [Run Locally](#run-locally)
@@ -46,7 +46,7 @@ The App Engine Node.js samples typically require that you do the following:
         npm start
 
 
-1.  Visit the application at [http://localhost:8080][].
+1.  Visit the application at http://localhost:8080.
 
 ## Deploying
 

appengine/endpoints/README.md

@@ -17,7 +17,7 @@ Then, deploy the sample using `gcloud`:
 
     gcloud beta app deploy
 
-Once deployed, you can access the application at https://YOUR-PROJECT-ID.appspot.com/.
+Once deployed, you can access the application at `https://YOUR-PROJECT-ID.appspot.com/`.
 
 ## Send an echo request
 

functions/README.md

@@ -20,14 +20,9 @@ environment.
 ## Samples
 
 * [Hello World](helloworld/)
-* [Background](background/)
-* [Callbacks](messages/)
 * [Cloud Pub/Sub](pubsub/)
 * [Cloud Spanner](spanner/)
-* [Dependencies](uuid/)
-* [Error Reporting](errorreporting/)
 * [HTTP](http/)
 * [Logging & Monitoring](log/)
 * [OCR (Optical Character Recognition)](ocr/)
-* [SendGrid](sendgrid/)
 * [Slack](slack/)

linkinator.config.json

@@ -0,0 +1,10 @@
+{
+  "recurse": true,
+  "skip": [
+    "http://localhost:8080*",
+    "\/node_modules\/"
+  ],
+  "silent": true,
+  "concurrency": 10,
+  "directoryListing": true
+}

monitoring/opencensus/README.md

@@ -17,20 +17,20 @@ OpenCensus is a toolkit for collecting application performance and behavior data
         npm install
 
 
-[prereq]: ../README.md#prerequisites
-[run]: ../README.md#how-to-run-a-sample
+[prereq]: ../../README.md#prerequisites
+[run]: ../../README.md#how-to-run-a-sample
 
 ## Samples
 
 ### SLI metrics
 
 View the [documentation][stats_0_docs] or the [source code][stats_0_code].
 
-Start the server locally by running 
-    
+Start the server locally by running
+
     node app.js
-    
-and send requests to it at 
+
+and send requests to it at
 
     http://localhost:8080
 

monitoring/prometheus/README.md

@@ -16,8 +16,8 @@ Prometheus is an open-source systems monitoring and alerting toolkit originally
 
         npm install
 
-[prereq]: ../README.md#prerequisites
-[run]: ../README.md#how-to-run-a-sample
+[prereq]: ../../README.md#prerequisites
+[run]: ../../README.md#how-to-run-a-sample
 
 ## Samples
 
@@ -26,9 +26,9 @@ Prometheus is an open-source systems monitoring and alerting toolkit originally
 View the [documentation][prometheus_0_docs] or the [source code][prometheus_0_code].
 
 Start the server locally by running
-  
+
  node app.js
-  
+
 and send requests to it at
 
     http://localhost:8080

run/idp-sql/README.md

@@ -7,7 +7,7 @@ Use it with the [End user Authentication for Cloud Run](http://cloud.google.com/
 
 For more details on how to work with this sample read the [Google Cloud Run Node.js Samples README](https://github.com/GoogleCloudPlatform/nodejs-docs-samples/tree/master/run).
 
-[![Run on Google Cloud](https://deploy.cloud.run/button.svg)](https://deploy.cloud.run)
+[![Run on Google Cloud](https://deploy.cloud.run/button.svg)](https://deploy.cloud.run/?git_repo=https://github.com/GoogleCloudPlatform/nodejs-docs-samples&dir=run/idp-sql)
 
 ## Dependencies
 
@@ -49,7 +49,7 @@ Other environment variables:
 
 * Saving credentials directly as environment variables is convenient for local testing,
   but not secure for production; therefore using `CLOUD_SQL_CREDENTIALS_SECRET`
-  in combination with the Cloud Secrets Manager is recommended.  
+  in combination with the Cloud Secrets Manager is recommended.
 
 ## Running Locally
 

workflows/quickstart/README.md

@@ -17,11 +17,11 @@ This sample shows how to execute a Cloud Workflow and wait for the workflow exec
 ## Run the Quickstart
 
 1. Run the script, either with environment variables or command-line arguments:
-  
+
     `node . <projectId> [cloudRegion] [workflowName]`.
-  
+
     _or_
-    
+
     `GOOGLE_CLOUD_PROJECT=... node .`: The Cloud project with the workflow `myFirstWorkflow`.
 
 1. Observe the results:
@@ -32,4 +32,4 @@ This sample shows how to execute a Cloud Workflow and wait for the workflow exec
     ["Wednesday","Wednesday Night Wars","Wednesday 13","Wednesday Addams","Wednesday Campanella","Wednesdayite","Wednesday Martin","Wednesday Campanella discography","Wednesday Night Hockey (American TV program)","Wednesday Morning, 3 A.M."]
     ```
 
-[prereq]: ../README.md#prerequisities
+[prereq]: ../../README.md#prerequisities