Ignoring results for checking broken web links are hiding actual broken internal links

Open Beginner friendly
#1,251 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Quiet
Domain
ci-cd, documentation

Research direction

Start with the website build's current unbroken invocation and the CI configuration changed by #1150. Add a separate --local-only check without a timeout, while retaining the timeout for external-link checking. Done means broken internal links fail the build without making external timeouts fail it.

Written by the indexing model from the issue text.

Description

bug documentation Needs: Triage :mag:
Page url

https://microsoft.github.io/react-native-windows/v1/docs/debugging-javascript

Problem Description

The CI was updated in #1150 to allow it to pass if time-outs occur when checking for links. Which is fine, except there are local only links within the website that are also failing, and are also being ignored.

For example, see the link provided, with a broken image:

Image

I'd recommend two separate checks in the website building:

  1. One that calls unbroken with --local-only to catch broken internal links (between docs pages) and has no time-out
  2. The current call to unbroken that also checks external links, and has the timeout
Dominant language
C#
Stars
544
Forks
218
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/react-native-windows-samples

All issues in microsoft/react-native-windows-samples

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.