-
Notifications
You must be signed in to change notification settings - Fork 991
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
[WIP] Upgrade Docusaurus to v3.7.0 #6851
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is currently redirected, so opted to delete rather than update to support it in the new Docusaurus version.
@@ -270,7 +268,6 @@ var siteSettings = { | |||
], | |||
plugins: [ | |||
[path.resolve("plugins/insertMetaTags"), { metatags }], | |||
path.resolve("plugins/svg"), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This custom svg plugin was created during the initial Docusaurus setup. It didn't feel necessary, and svgs still appear to work after removing this plugin.
Re: the @john-rock feel free to hold off on the review for this for now. |
@john-rock Okay I gave up on trying to make the |
You give up fast 😅 If you can't upgrade to v4 due to the documented breaking changes, v3 is also compatible and works:
Your site now bundles in 15s instead of 60s |
@slorber I was doing my best to avoid the potential rabbit hole of getting stuck on this another day 😅
That did it. The That latest deploy was the fastest we've ever had for our Docs site. Again, thank you for your help with this and following up here with that suggestion! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm, clicked through a variety of pages and everything seems to be working as expected. Love to see the faster build times.
Just dropped a comment about a {}
inside package.json
.
package.json
Outdated
@@ -0,0 +1 @@ | |||
{} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Leftover artifact?
What are you changing in this pull request and why?
This upgrades Docusaurus to v3.7.0. The primary goal for the upgrade is to access new Docusaurus Faster features, which will hopefully improve the build times, and reduce the bundle sizes.
Preview
Click through the site and verify pages working correctly:
Notes
I was unable to get the
rspackBundler
working due to us using the@stoplight/elements
package in our api pages. Rspack replaces Webpack for bundling the site, but we have a custom webpack config plugin which sets a Node polyfill to allow this package to work.This webpack config is supposed to continue to work when using the Rspack bundler, but i haven't been able to figure it out. Will save that to try again on a rainy day... When it comes time to try enabling
rspackBundler
again, we can follow these steps:rspackBundler: true
in docusaurus.config.jsnode-polyfill-webpack-plugin
to latest version (or at least >= v3)/dbt-cloud/api-v2
and/dbt-cloud/api-v3
pages.More deets in this Git thread.