microsoft / microsoft/react-native-windows-samples
Ignoring results for checking broken web links are hiding actual broken internal links
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 544
- Forks
- 218
- PR merge metrics
- No merged PRs in 30d
Description
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:
I'd recommend two separate checks in the website building:
- One that calls unbroken with
--local-onlyto catch broken internal links (between docs pages) and has no time-out - The current call to unbroken that also checks external links, and has the timeout
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Domain
- ci-cd, documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100