question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Upgrade docusaurus on the microsite

See original GitHub issue

Feature 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:closed
  • Created 2 years ago
  • Comments:11 (9 by maintainers)

github_iconTop GitHub Comments

2reactions
adamdmharveycommented, Dec 2, 2021

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.

1reaction
jhaalscommented, Dec 14, 2021

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

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found