Skip to content

Conversation

@mhkuu
Copy link
Contributor

@mhkuu mhkuu commented Sep 4, 2024

Fixes #316

Summary

This PR updates Docusaurus to the latest version (3.5). This PR addresses all required changes to make the migration.

Relevant technical choices

The individual commits show how the updating took place:

  1. 7c5ae4c updates the dependencies as per https://docusaurus.io/docs/migration/v3#upgrading-dependencies
  2. a4e3a71 fixes some Markdown as per https://docusaurus.io/docs/migration/v3#using-the-mdx-checker-cli
  3. 2f7c047 transforms the configuration file, with the most pressing change being the way we import themes, see https://docusaurus.io/docs/migration/v3#prism-react-renderer-v20
  4. 643e56d fixes the MDX loader for the changelog plugin, see fix: remove useless js-loader in front of mdx-loader facebook/docusaurus#8972 for context.
  5. 8b4586a updates the imports, as some stuff has moved from @docusaurus/theme-common/internal to plugin-content-blog/client or plugin-content-docs/client.
  6. b8b89d9 moves plugin-content-blog to an actual dependency instead of a development dependency.

Test instructions

This PR can be acceptance tested by following these steps:

  1. Run docusaurus clear and delete node_modules to prevent any caches.
  2. Run yarn to install all dependencies.
  3. Run npx docusaurus-mdx-checker and confirm all files are compiled successfully.
  4. Run yarn start and confirm the developer docs are locally built and served successfully.
  5. Run yarn build and yarn serve to confirm the developer docs can also be successfully built for production.
  6. Do a few smoke tests to confirm everything works as before.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Sep 4, 2024

Deploying yoast-developer with  Cloudflare Pages  Cloudflare Pages

Latest commit: eaa6014
Status: ✅  Deploy successful!
Preview URL: https://e26af1eb.yoast-developer.pages.dev
Branch Preview URL: https://update-docusaurus.yoast-developer.pages.dev

View logs

@Djennez Djennez merged commit 6f854e2 into main Sep 19, 2024
@Djennez Djennez deleted the update-docusaurus branch September 19, 2024 07:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Updating Docusaurus

2 participants