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

chore(ia): Tidy MDN meta dir #37784

Merged
merged 30 commits into from
Jan 31, 2025
Merged

chore(ia): Tidy MDN meta dir #37784

merged 30 commits into from
Jan 31, 2025

Conversation

bsmth
Copy link
Member

@bsmth bsmth commented Jan 24, 2025

Description

Notable: pages worth checking prose:

  • files/en-us/mdn/index.md
  • files/en-us/mdn/community/index.md
  • files/en-us/mdn/community/open_source_etiquette/index.md
  • files/en-us/mdn/community/our_repositories/index.md

Changes:

  • sidebars are formatted using rari content fmt-sidebars
  • short-titles in writing guidelines how-tos
  • non-files/en-us/mdn/ changes update cross-references to moved files
  • MDN/Changelog -> MDN/Writing_guidelines/Changelog

Removals:

  • PAB & At_ten content removed in favor of the About page

Motivation

Docs IA & maintenance

@bsmth bsmth requested review from a team as code owners January 24, 2025 09:45
@bsmth bsmth requested review from hamishwillee and removed request for a team January 24, 2025 09:45
@github-actions github-actions bot added Content:Meta Content in the meta docs size/xl [PR only] >1000 LoC changed labels Jan 24, 2025
Copy link
Contributor

github-actions bot commented Jan 24, 2025

Preview URLs (77 pages)
Flaws (5)

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

URL: /en-US/docs/MDN
Title: MDN Web Docs
Flaw count: 2

  • broken_links:
    • Can't resolve /en-US/about
  • unknown:
    • No generic content config found

URL: /en-US/docs/MDN/Writing_guidelines/Page_structures/Page_types/API_reference_page_template
Title: API reference page template
Flaw count: 1

  • unknown:
    • Invalid slug for templ/sidebar: MDN/Writing_guidelines/Page_structures/Page_types/API_reference_page_template

URL: /en-US/docs/MDN/Writing_guidelines/Page_structures/Sidebars
Title: Sidebars
Flaw count: 2

  • broken_links:
    • https://developer.mozilla.org/en-US/docs/MDN/Changelog is a redirect
    • https://developer.mozilla.org/en-US/docs/Web/HTML is a redirect
External URLs (14)

URL: /en-US/docs/MDN/Community/Roles_teams
Title: MDN Web Docs roles and teams


URL: /en-US/docs/MDN/Community/Open_source_etiquette
Title: Open source etiquette


URL: /en-US/docs/MDN/Community/Getting_started
Title: Getting started with MDN Web Docs


URL: /en-US/docs/MDN/Community/Pull_requests
Title: Pull request submission and reviews

(comment last updated: 2025-01-31 16:19:14)

files/en-us/_redirects.txt Outdated Show resolved Hide resolved
@bsmth bsmth requested a review from caugner January 24, 2025 09:58
@bsmth bsmth mentioned this pull request Jan 24, 2025
1 task
Comment on lines +18 to +21
- [rari](https://github.com/mdn/rari)
- : This is the backend part of the MDN Web Docs platform, where you'll go if you want to make changes to page structures and rendering machinery.
- [yari](https://github.com/mdn/yari)
- : This is the frontend part of the MDN Web Docs platform, where you'll find styles, design, and layout functionality.
Copy link
Collaborator

Choose a reason for hiding this comment

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

IMO these are infrastructure, even if they are main repositories, they shoud be there because most consumers of this document need to know very little about them.


- : These guides help you get started with contributing to MDN Web Docs. They also cover topics such as how you can help with tasks and issues, open discussions, and suggest content. If you need help or want to contact us, you'll find the information here.
**MDN Web Docs** is a free-to-use resource documenting open web technologies.
Our mission is to provide developers with the information they need to easily build projects on the web platform.
Copy link
Collaborator

@hamishwillee hamishwillee Jan 28, 2025

Choose a reason for hiding this comment

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

What is "the web platform"? We use the term a lot, and I think we kind of have a somewhat clear definition of that that means. But it feels like a term that should be linked. Anyway, just rambling now, this is a huge PR to review.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good point, we should explain that.

this is a huge PR to review.

Sorry, and thank you! :)

Copy link
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

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

@bsmth I've finished looking. Can't guarantee the review was thorough, but I did look at all the pages. I always worry that as reviewer I'll be the last person that reads this kind of docs, but I guess we have to have it :-0

Anyway, these changes look sane, in particular the deletion of some of the cruft and the naming consistency work.

@github-actions github-actions bot added the Content:Learn Learning area docs label Jan 29, 2025
@bsmth
Copy link
Member Author

bsmth commented Jan 31, 2025

@bsmth I've finished looking. Can't guarantee the review was thorough, but I did look at all the pages. I always worry that as reviewer I'll be the last person that reads this kind of docs, but I guess we have to have it :-0

Anyway, these changes look sane, in particular the deletion of some of the cruft and the naming consistency work.

Thank you very much 🙏🏻

Copy link
Member

@pepelsbey pepelsbey left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks :) Just a tiny nitpick.

@bsmth
Copy link
Member Author

bsmth commented Jan 31, 2025

Thanks, all! Merging now!

@bsmth bsmth merged commit 719645a into mdn:main Jan 31, 2025
9 checks passed
@bsmth bsmth deleted the mdn-dir-meta branch January 31, 2025 16:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Learn Learning area docs Content:Meta Content in the meta docs size/xl [PR only] >1000 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants