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

upgrade to docusaurus 3 #9820

Merged
merged 8 commits into from Mar 23, 2024
Merged

upgrade to docusaurus 3 #9820

merged 8 commits into from Mar 23, 2024

Conversation

chris48s
Copy link
Member

@chris48s chris48s commented Dec 18, 2023

Closes #9816

This PR upgrades

  • @docusaurus/core
  • @mdx-js/react
  • docusaurus-openapi and
  • react/react-dom

and I've made all the necessary formatting changes to all of the documentation to make MDXv3 happy, display everything sensibly and fix all the validateDOMNesting warnings (mostly <p> cannot appear as a descendant of <p> and <a> cannot appear as a descendant of <a> warnings).

This PR is changing a lot at once, but I have split things out into commits so the functional changes are easy to separate from the minor alterations to documentation markup.

Relevant background reading:

One of the things that docusaurus 3 should allow us to do is migrate the frontend from CJS to ESM, but I've decided not to do that here because we don't have to do it in order to upgrade and the PR is already big. I'm going to punt that change to a follow up issue.

@chris48s chris48s added the dependencies Related to dependency updates label Dec 18, 2023
Copy link
Contributor

github-actions bot commented Dec 18, 2023

Warnings
⚠️ This PR modified service code for bugzilla but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for bundlejs but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for circleci but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for codecov but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for date but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for discord but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for dynamic but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for endpoint but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for github/gist but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for github but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for gitlab but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for jenkins but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for localizely but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for matrix but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for nexus but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for pypi but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for ros but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for sonar but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for static-badge but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for steam but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for visual-studio-marketplace but not its test code.
That's okay so long as it's refactoring existing code.
⚠️ This PR modified service code for wikiapiary but not its test code.
That's okay so long as it's refactoring existing code.
Messages
📖 ✨ Thanks for your contribution to Shields, @chris48s!
📖

Thanks for contributing to our documentation. We ❤️ our documentarians!

Generated by 🚫 dangerJS against e4f7224

Copy link

socket-security bot commented Dec 18, 2023

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/@docusaurus/core@3.1.1 Transitive: environment, eval, filesystem, network, shell, unsafe +243 27.1 MB slorber
npm/@mdx-js/react@3.0.1 None +5 1.71 MB wooorm
npm/docusaurus-preset-openapi@0.7.3 Transitive: environment, eval, filesystem, network, shell, unsafe +254 40.9 MB bourdakos1

🚮 Removed packages: npm/@docusaurus/core@2.4.3, npm/@mdx-js/react@1.6.22, npm/docusaurus-preset-openapi@0.6.4

View full report↗︎

@chris48s

This comment was marked as outdated.

@chris48s

This comment was marked as outdated.

@chris48s chris48s changed the title WIP docusaurus 3 upgrade to docusaurus 3 Feb 26, 2024
@chris48s chris48s added the blocker PRs and epics which block other work label Feb 26, 2024
fixes performing the 'execute' action when pressing enter
@chris48s chris48s marked this pull request as ready for review February 26, 2024 17:32
@chris48s
Copy link
Member Author

I'll keep this updated as we merge new stuff, but this one would be really useful to get a review on sooner rather than later as it touches a lot of things.

Copy link
Contributor

🚀 Updated review app: https://pr-9820-badges-shields.fly.dev

Copy link
Contributor

🚀 Updated review app: https://pr-9820-badges-shields.fly.dev

@chris48s
Copy link
Member Author

I've decided I'm just going to go rogue and merge this one.
If anyone decides I've done a bad thing, I can address it in a follow up PR.

@chris48s chris48s merged commit bd3a11b into badges:master Mar 23, 2024
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocker PRs and epics which block other work dependencies Related to dependency updates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Upgrade docusaurus and docusaurus-openapi
1 participant