Upgrade docusaurus on the microsite
See original GitHub issueFeature Suggestion
The /microsite
directory uses a dependency on an alpha version of docusaurus
. This version is getting a bit old and has some vulnerable dependencies that we want to get rid of. The docusaurus releases are now at a beta level, are shipped under a @docusaurus/*
scope, and the generated project structure is different than it used to be in the alpha.
Possible Implementation
The migration from the alpha project structure to the beta project structure seems to be slightly involved. For example, the way that sidebars are loaded has changed. It may be worth scaffolding an entirely empty fresh docusaurus site, and retro-fitting our content into that.
Issue Analytics
- State:
- Created 2 years ago
- Comments:11 (9 by maintainers)
Top Results From Across the Web
Installation - Docusaurus
Updating your Docusaurus version. There are many ways to update your Docusaurus version. One guaranteed way is to manually change the version ...
Read more >Announcing Docusaurus 2.0
Highly customized Docusaurus sites sometimes have a hard time upgrading Docusaurus because they achieve customizations using internal APIs.
Read more >Creating your site - Docusaurus v1
To create a fully functional site, you only need to do a few steps: Add your documentation to the /docs directory as .md...
Read more >Introduction | Docusaurus
For existing v1 users that are seeking to upgrade to v2, you can follow our migration guide. Features. Docusaurus is built with high...
Read more >Navigation and Sidebars - Docusaurus v1
Referencing Site Documents. If you want to reference another document in your docs directory (or the location you set via the optional ...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
I actually played around with this the other day. There are some nice steps documented here:
https://docusaurus.io/docs/migration
Although it’s called v1 to v2 migration, and we’re on a v2 alpha, most of them are simimiar as it seems many of the major structural changes came after the alpha version Backstage.io is on.
Where I ran into the biggest aspect of change is in styling; much of the Docusaurus customizations need to be pulled out into a CSS and referenced externally. Otherwise the other mechanics (changing the package structure, renaming the config file, etc) are relatively straight forward if someone wants to tackle those as a start! Maybe a collaborative PR.
Hey @cmpadden!
Nice to see that you’re interested in taking this up! 💯 I would love if this could be done in smaller increments otherwise this is going to be hard to review and keep as a working branch 😃 Migrating away from class components for example could probably be done prior to upgrading to latest. There is probably a lot of other things that could be shipped in chunks as well