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.

Sign up for GitHub

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

Jump to bottom

Convert noteblocks for mdn folder #35080

Merged
merged 2 commits into from
Jul 25, 2024
Merged

Convert noteblocks for mdn folder #35080

merged 2 commits into from
Jul 25, 2024

Conversation

queengooborg
Copy link
Collaborator

This PR converts the noteblocks for the 'mdn' folder to GFM syntax, using a conversion script.

@queengooborg
Convert noteblocks for mdn folder
525d4e5 
This PR converts the noteblocks for the 'mdn' folder to GFM syntax, using a [conversion script](https://github.com/queengooborg/mdn-toolkit/blob/main/upgrade-noteblock.js).
@queengooborg queengooborg requested a review from a team as a code owner July 25, 2024 19:54
@queengooborg queengooborg requested review from hamishwillee and removed request for a team July 25, 2024 19:54
@github-actions github-actions bot added Content:Meta Content in the meta docs size/m [PR only] 51-500 LoC changed labels Jul 25, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 25, 2024 •
edited

Preview URLs (41 pages)
Flaws (1)

Note! 40 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/MDN/Writing_guidelines/Attrib_copyright_license
Title: Attribution and copyright licensing
Flaw count: 1

  • broken_links:
    • Link points to the page it's already on
External URLs (4)

URL: /en-US/docs/MDN/Writing_guidelines/Howto/Images_media
Title: How to add images and media

URL: /en-US/docs/MDN/Writing_guidelines/Attrib_copyright_license
Title: Attribution and copyright licensing

URL: /en-US/docs/MDN/Writing_guidelines/Writing_style_guide
Title: Writing style guide

URL: /en-US/docs/MDN/Writing_guidelines/Experimental_deprecated_obsolete
Title: Experimental, deprecated, and obsolete

(comment last updated: 2024-07-25 20:54:24)

Josh-Cena
Josh-Cena approved these changes Jul 25, 2024
View reviewed changes
Copy link
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

Existing changes aren't regressions so I wouldn't block, but (1) I see several notes not converted and I wonder if there are more similar cases; (2) The meta docs about callout syntax have already been updated separately, right?

files/en-us/mdn/writing_guidelines/writing_style_guide/index.md
@@ -155,7 157,8 @@ The following checklist is good to keep in mind while writing and reviewing cont
- **Add image information**: Include proper [`alt`](/en-US/docs/Web/HTML/Element/img#alt) text on all images and diagrams. This text, as well as captions on tables and other figures, counts because spiders can't crawl images, and so `alt` text tells search engine crawlers what content the embedded media contains.
> **Note:** It is not recommended to include too many keywords or keywords not related to the feature in an attempt to manipulate search engine rankings; this type of behavior is easy to spot and tends to be penalized.
Copy link
Member

Choose a reason for hiding this comment

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

Why isn't this converted?

Copy link
Collaborator Author

@queengooborg queengooborg Jul 25, 2024 •
edited

Choose a reason for hiding this comment

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

Noteblocks inside of lists are getting incorrectly formatted by Markdownlint, so I avoided converting them for the time being! (That applies to any noteblocks that are left unconverted as well!)

@queengooborg queengooborg merged commit ce83b64 into main Jul 25, 2024
9 checks passed
@queengooborg queengooborg deleted the gfm-noteblock/mdn branch July 25, 2024 21:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Josh-Cena Josh-Cena Josh-Cena approved these changes

@hamishwillee hamishwillee Awaiting requested review from hamishwillee hamishwillee is a code owner automatically assigned from mdn/yari-content-mdn

Assignees
No one assigned
Labels
Content:Meta Content in the meta docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@queengooborg @Josh-Cena