From e86cffdc8628a2a79493c3814c642682aa9e4549 Mon Sep 17 00:00:00 2001 From: Yousaf Nabi Date: Tue, 22 Mar 2022 11:24:50 +0000 Subject: [PATCH] fix: correct broken links and fail build on further broken links --- .../docs/getting_started/provider_verification.md | 4 ++-- website/docs/pact_broker.md | 2 +- website/docs/pact_broker/advanced_topics/api_docs.md | 10 +++++----- .../docs/pact_broker/webhooks/debugging_webhooks.md | 2 +- website/docs/recipes.md | 12 ++++++------ website/docusaurus.config.js | 2 +- 6 files changed, 16 insertions(+), 16 deletions(-) diff --git a/website/docs/getting_started/provider_verification.md b/website/docs/getting_started/provider_verification.md index 2a0ced30..6cfc8d1f 100644 --- a/website/docs/getting_started/provider_verification.md +++ b/website/docs/getting_started/provider_verification.md @@ -12,7 +12,7 @@ Need to know what Pact provider verification is? Check out the provider verifica Already know what provider verification is, but need help coding it up? Here are the links to the relevant provider documentation for our most popular languages. -* [Pact JVM](/implementation_guides/jvm/provider_menu) (select your JVM testing library from the menu) +* [Pact JVM](/implementation_guides/jvm/provider) (select your JVM testing library from the menu) * [Pact JS](/implementation_guides/javascript/readme#provider-api-testing) * [Pact Net](/implementation_guides/net/readme#service-provider) * [Pact Go](/implementation_guides/go/readme#provider-api-testing) @@ -21,7 +21,7 @@ Already know what provider verification is, but need help coding it up? Here are * [Pact Rust](/implementation_guides/rust/pact_verifier_cli) * [Pact PHP](https://github.com/pact-foundation/pact-php/#basic-provider-usage) -Can't see your language listed above? Go to the [Pact Docs](/implementation_guides/) page and double check to see if your language is supported. If it's not, you can use the language agnostic [Provider Verifier CLI](/implementation_guides/cli#provider-verifier). +Can't see your language listed above? Go to the [Pact Docs](/implementation_guides/cli) page and double check to see if your language is supported. If it's not, you can use the language agnostic [Provider Verifier CLI](/implementation_guides/cli#provider-verifier). ## What do I do next? diff --git a/website/docs/pact_broker.md b/website/docs/pact_broker.md index 87f51f50..3cf29243 100644 --- a/website/docs/pact_broker.md +++ b/website/docs/pact_broker.md @@ -153,7 +153,7 @@ You can use the [Pact Broker Docker image](https://hub.docker.com/r/pactfoundati \` * Please ensure you use `encoding: 'utf8'` in your Sequel options to avoid encoding issues. -* For production usage, use a web application server like [Phusion Passenger](https://www.phusionpassenger.com) or [Nginx](http://nginx.org/) to serve the Pact Broker application. You'll need to read up on the documentation for these yourself as it is beyond the scope of this documentation. See the [wiki](/pact_broker/configuration#running-the-broker-behind-a-reverse-proxy) for instructions on using a reverse proxy with SSL. +* For production usage, use a web application server like [Phusion Passenger](https://www.phusionpassenger.com) or [Nginx](http://nginx.org/) to serve the Pact Broker application. You'll need to read up on the documentation for these yourself as it is beyond the scope of this documentation. See the [wiki](/pact_broker/configuration/features#running-the-broker-behind-a-reverse-proxy) for instructions on using a reverse proxy with SSL. * Ensure the environment variable `RACK_ENV` is set to `production`. * Deploy to your location of choice. diff --git a/website/docs/pact_broker/advanced_topics/api_docs.md b/website/docs/pact_broker/advanced_topics/api_docs.md index 6b766753..a93f6e67 100644 --- a/website/docs/pact_broker/advanced_topics/api_docs.md +++ b/website/docs/pact_broker/advanced_topics/api_docs.md @@ -8,9 +8,9 @@ For an up-to-date list of all the API resources, view the actual code [here](htt _Key resources:_ -* [Publishing pacts](./publish_pact) -* [Publishing verification results](./publish_verification_result) -* [Webhooks](./webhooks) -* [Pacticipants](./pacticipant) -* [Pact diff](./pact_diff) +* [Publishing pacts](./api_docs/publish_pact) +* [Publishing verification results](./api_docs/publish_verification_result) +* [Webhooks](./api_docs/webhooks) +* [Pacticipants](./api_docs/pacticipant/) +* [Pact diff](./api_docs/pact_diff/) diff --git a/website/docs/pact_broker/webhooks/debugging_webhooks.md b/website/docs/pact_broker/webhooks/debugging_webhooks.md index 4fc1c09d..05c1ab10 100644 --- a/website/docs/pact_broker/webhooks/debugging_webhooks.md +++ b/website/docs/pact_broker/webhooks/debugging_webhooks.md @@ -49,6 +49,6 @@ The properties section will tell you how many of the webhooks succeeded for the The Embedded Resources section will give you links to the execution logs. -By default, for security purposes, the execution logs will be hidden. You will need to configure the whitelist to see the logs. If you are using one of the [Docker images](/pact_broker/docker_images) you can configure the whitelist via environment variables, documented [here](/pact_broker/docker_images/dius#webhook-whitelists). The documentation that explains how the whitelists work is [here](/pact_broker/configuration#webhook-whitelists) (note that the example code shows how to configure the underlying Ruby application, however, if you are using a Docker image, you need to use the environment variables in the first link). +By default, for security purposes, the execution logs will be hidden. You will need to configure the whitelist to see the logs. If you are using one of the [Docker images](/pact_broker/docker_images) you can configure the whitelist via environment variables, documented [here](/pact_broker/docker_images/dius#webhook-whitelists). The documentation that explains how the whitelists work is [here](/pact_broker/configuration/features#webhook-whitelists) (note that the example code shows how to configure the underlying Ruby application, however, if you are using a Docker image, you need to use the environment variables in the first link). If you see no evidence of any attempted executions, look in the application logs. For every pact publication, there are detailed logs that explain why a webhook is/isn't fired for a particular publication. See [Identifying why a webhook did or did not get triggered](#identifying-why-a-webhook-did-or-did-not-get-triggered) diff --git a/website/docs/recipes.md b/website/docs/recipes.md index cd38f672..0620bf04 100644 --- a/website/docs/recipes.md +++ b/website/docs/recipes.md @@ -8,13 +8,13 @@ Recipes and pre-built integrations to test common scenarios in Pact | Recipe/Integration | Description | | ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- | -| [GraphQL](graphql) | Strategies for testing GraphQL endpoints (example with Apollo) | -| [API Gateway](apigateway) | Strategies for dealing with API Gateways, such as AWS API Gateway, Kong etc. | -| [Lambda/FaaS (Asynchronous)](recipes/lambdaasync) | How to write contract tests for asynchronous lambda functions / FaaS | -| [Lambda (HTTP)](lambdahttp) | How to write contract tests for HTTP based lambdas with AWS SAM | -| [Cypress](cypress) | Best practices for integrating Pact with Cypress, and converting your cypress `cy.route()` / `cy.intercept()` calls into pact files | +| [GraphQL](/recipes/graphql) | Strategies for testing GraphQL endpoints (example with Apollo) | +| [API Gateway](/recipes/apigateway) | Strategies for dealing with API Gateways, such as AWS API Gateway, Kong etc. | +| [Lambda/FaaS (Asynchronous)](/recipes/lambdaasync) | How to write contract tests for asynchronous lambda functions / FaaS | +| [Lambda (HTTP)](/recipes/lambdahttp) | How to write contract tests for HTTP based lambdas with AWS SAM | +| [Cypress](/recipes/cypress) | Best practices for integrating Pact with Cypress, and converting your cypress `cy.route()` / `cy.intercept()` calls into pact files | | [MSW](https://github.com/you54f/msw-pact) | Library for integrating MSW with Pact | | [NestJS](https://github.com/omermorad/nestjs-pact) | Library for integrating Pact with NestJS | -| [Kafka](kafka) | How to test Kafka messages with Pact | +| [Kafka](/recipes/kafka) | How to test Kafka messages with Pact | | [Jest](https://github.com/pact-foundation/jest-pact) | A Pact adaptor for to allow you to easily run tests with Jest | | [Mocha](https://github.com/pact-foundation/mocha-pact) | A Pact adaptor for to allow you to easily run tests with Mocha | diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 5ce029e3..9f663ea0 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -69,7 +69,7 @@ const siteConfig = { tagline: "Test your integrations quickly. Deploy your apps safely.", url: "https://docs.pact.io", // Your website URL baseUrl: "/", - onBrokenLinks: "warn", + onBrokenLinks: "error", // Fail the build on broken links customFields: { users: users, },