Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken links #112

Closed
bethesque opened this issue Feb 21, 2022 · 4 comments · Fixed by #122
Closed

Fix broken links #112

bethesque opened this issue Feb 21, 2022 · 4 comments · Fixed by #122
Assignees

Comments

@bethesque
Copy link
Member

When running scripts/build.sh there are a number of broken links reported.

Exhaustive list of all broken links found:

- On source page path = /getting_started/provider_verification:
   -> linking to /implementation_guides/jvm/provider_menu
   -> linking to /implementation_guides/

- On source page path = /pact_broker:
   -> linking to /pact_broker/configuration#running-the-broker-behind-a-reverse-proxy (resolved as: /pact_broker/configuration)

- On source page path = /pact_broker/advanced_topics/api_docs:
   -> linking to ./publish_pact (resolved as: /pact_broker/advanced_topics/publish_pact)
   -> linking to ./publish_verification_result (resolved as: /pact_broker/advanced_topics/publish_verification_result)
   -> linking to ./webhooks (resolved as: /pact_broker/advanced_topics/webhooks)
   -> linking to ./pact_diff (resolved as: /pact_broker/advanced_topics/pact_diff)

- On source page path = /pact_broker/webhooks/debugging_webhooks:
   -> linking to /pact_broker/configuration#webhook-whitelists (resolved as: /pact_broker/configuration)

- On source page path = /recipes:
   -> linking to graphql (resolved as: /graphql)
   -> linking to apigateway (resolved as: /apigateway)
   -> linking to lambdahttp (resolved as: /lambdahttp)
   -> linking to cypress (resolved as: /cypress)
   -> linking to kafka (resolved as: /kafka)
@mefellows
Copy link
Member

I saw this the other day too. I think we should consider breaking the build if this finds errors.

@YOU54F
Copy link
Member

YOU54F commented Feb 24, 2022

I think I have broken these highlighted below in the following PR https://github.com/pact-foundation/docs.pact.io/pull/110/files

  • On source page path = /recipes:
    -> linking to graphql (resolved as: /graphql)
    -> linking to apigateway (resolved as: /apigateway)
    -> linking to lambdahttp (resolved as: /lambdahttp)
    -> linking to cypress (resolved as: /cypress)
    -> linking to kafka (resolved as: /kafka)

which is odd, as the issue was reported that the link was resolving to https://docs.pact.io/recipes/recipes/kafka which is a dead link. (dupe recipes)

Even odder, is that I forgot to change one of them 🤦🏾 Lambda/FaaS (Asynchronous) and that one works fine now.

@YOU54F
Copy link
Member

YOU54F commented Mar 2, 2022

It is the opposite way round again! 🤷🏾‍♂️

https://docs.pact.io/recipes/

The Lambda/FaaS (Asynchronous) link is resolving to the wrong place, but the ones identified as broken are now working again

eg

Cypress

Will put this on my list of things to look at 👍🏾

@bethesque
Copy link
Member Author

Yeah, there was an issue with paths ending in /readme that I've fixed now, that may have been related.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants