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(ci): Reuse markdownlint config files for 'files' and 'docs' hiera… #15106

Merged
merged 3 commits into from
Aug 15, 2023

Conversation

OnkarRuikar
Copy link
Contributor

Addresses #14246 (comment)

No, we don't need different definitions for the docs folder -- what I mean is, the extends property isn't working.

The config under files/zh-cn/ directory can be reused in docs/zh-cn/ using the changes in the PR. Same for zh-tw locale.

Explanation

The config file .markdownlint.jsonc is related to the core markdownlint library. And .markdownlint-cli2.jsonc is related to markdownlint-cli2 tool that uses the markdownlint.

The extends property belongs to the config property in .markdownlint-cli2.jsonc. Under the hood the config property is the configuration for .markdownlint.jsonc. As the config is solely related to makrdownlint the extends need to point to .markdownlint.jsonc files not .markdownlint-cli2.jsonc.

Note .markdownlint-cli2.jsonc is used only at the root level to provide CLI specific configs. And all core markdownlint related configurations have been put in .markdownlint.jsonc files.

@OnkarRuikar OnkarRuikar requested review from a team as code owners August 14, 2023 19:03
@OnkarRuikar OnkarRuikar requested review from irvin and removed request for a team August 14, 2023 19:03
@github-actions github-actions bot added the system Infrastructure and configuration for the project label Aug 14, 2023
@OnkarRuikar OnkarRuikar marked this pull request as draft August 14, 2023 19:29
@OnkarRuikar OnkarRuikar marked this pull request as ready for review August 15, 2023 10:05
@OnkarRuikar OnkarRuikar requested a review from a team as a code owner August 15, 2023 10:11
@OnkarRuikar OnkarRuikar requested review from yujo11 and removed request for a team August 15, 2023 10:11
@github-actions github-actions bot added the l10n-ko Issues related to Korean content. label Aug 15, 2023
@OnkarRuikar
Copy link
Contributor Author

@queengooborg we can go with this as this is what you were trying to implement.

@github-actions
Copy link
Contributor

Preview URLs

Flaws (30)

URL: /ko/docs/Web/API/PointerEvent
Title: PointerEvent
Flaw count: 30

  • macros:
    • /ko/docs/Web/API/PointerEvent/PointerEvent does not exist but fell back to /en-US/docs/Web/API/PointerEvent/PointerEvent
    • /ko/docs/Web/API/PointerEvent/pointerId does not exist but fell back to /en-US/docs/Web/API/PointerEvent/pointerId
    • /ko/docs/Web/API/PointerEvent/width does not exist but fell back to /en-US/docs/Web/API/PointerEvent/width
    • /ko/docs/Web/API/PointerEvent/height does not exist but fell back to /en-US/docs/Web/API/PointerEvent/height
    • /ko/docs/Web/API/PointerEvent/pressure does not exist but fell back to /en-US/docs/Web/API/PointerEvent/pressure
    • and 24 more flaws omitted
  • broken_links:
    • Can use the English (en-US) link as a fallback

Copy link
Collaborator

@queengooborg queengooborg left a comment

Choose a reason for hiding this comment

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

Confirming this works as intended.

I see there's a Prettier formatting performed as well, but this was probably performed during the merge commit.

@queengooborg queengooborg merged commit 13d2ced into mdn:main Aug 15, 2023
10 checks passed
@OnkarRuikar OnkarRuikar deleted the reuse_lint_configs branch August 16, 2023 02:57
@yin1999
Copy link
Member

yin1999 commented Aug 16, 2023

Thanks @OnkarRuikar and @queengooborg!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
l10n-ko Issues related to Korean content. system Infrastructure and configuration for the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants