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(flaws): stop reporting absolute MDN blog links as broken #9080

Merged
merged 2 commits into from
Jul 18, 2023

Conversation

caugner
Copy link
Contributor

@caugner caugner commented Jun 13, 2023

Summary

Problem

We have a flaw that reports absolute MDN links, to ensure content uses relative links, so that they work on all environments (locally, stage and prod), and another flaw that reports relative MDN links that don't exist.

When we added relative links to MDN blog articles, this has been causing a flaw, because external contributors don't have the mdn/mdn-studio repository checked out, and even if they would, the flaw doesn't take the blog articles into consideration.

That's why relative links to MDN blog articles were replaced with absolute links, but that caused the other flaw.

Solution

Do not consider absolute links to MDN blog articles broken.


Screenshots

Before

image

After

image

How did you test this change?

Ran yarn && yarn dev (with REACT_APP_WRITER_MODE=true in my .env) and opened http://localhost:3000/en-US/docs/Web/CSS/:not#_flaws locally.

@caugner caugner requested a review from LeoMcA June 13, 2023 15:02
@github-actions github-actions bot added the flaw-system issues and feature requests related to the flaws system label Jun 13, 2023
@caugner caugner changed the title fix(flaws): stop reporting absolute MDN links as broken fix(flaws): stop reporting absolute MDN blog links as broken Jul 4, 2023
@caugner caugner force-pushed the dont-report-absolute-mdn-links-as-broken branch from 6059163 to 9f2b823 Compare July 4, 2023 08:44
@caugner caugner marked this pull request as ready for review July 4, 2023 08:48
Copy link
Member

@LeoMcA LeoMcA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@caugner caugner merged commit e59323f into main Jul 18, 2023
13 checks passed
@caugner caugner deleted the dont-report-absolute-mdn-links-as-broken branch July 18, 2023 14:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
flaw-system issues and feature requests related to the flaws system internal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants