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

chore: update to docusaurus v3 #1326

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

chore: update to docusaurus v3 #1326

wants to merge 12 commits into from

Conversation

timdeschryver
Copy link
Member

I wanted to see the impact of upgrading docusaurus, but everything seemed fined locally.
This is a test to verify that our pipeline still works.

@netlify
Copy link

netlify bot commented Oct 26, 2023

Deploy Preview for testing-library failed.

Name Link
🔨 Latest commit 9a82b3b
🔍 Latest deploy log https://app.netlify.com/sites/testing-library/deploys/6554885444e48700080a68a8

@MatanBobi
Copy link
Member

MatanBobi commented Oct 26, 2023

Thanks Tim!
AFAIR, the serious breaking change was upgrading to MDX v2, if our build passes I think we're good but maybe we can just verify it manually by running npx docusaurus-mdx-checker.

As far as I was able to see, there are also some visual changes, if you want I can have a look at those listed here:
https://docusaurus.io/blog/preparing-your-site-for-docusaurus-v3

@timdeschryver
Copy link
Member Author

You're right @MatanBobi
I don't see any changes between our live version and this preview version.

@MatanBobi
Copy link
Member

@timdeschryver i saw that they've released a new RC using MDX 3 today (or maybe that was yesterday?)

Are we waiting for the official release to merge this? I haven't had the time to review it yet so just wanted to know the urgency.

@timdeschryver
Copy link
Member Author

It can wait @MatanBobi

@nickmccurdy
Copy link
Member

Thanks, I've updated to RC 1 (latest). Would it make sense to compare against the latest version of our template too?

@timdeschryver
Copy link
Member Author

3.0.0 is released, I will update the PR later this week.

@nickmccurdy
Copy link
Member

nickmccurdy commented Nov 3, 2023

I can help with updating the PR, but I'd like to block it on #1339 so we don't have to manually add pnpm to the docs.

Copy link
Member

@MatanBobi MatanBobi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've browsed through the site and things look good :)
If it's ready in your opinion, feel free to merge this.
Thanks Tim!

@timdeschryver
Copy link
Member Author

timdeschryver commented Nov 3, 2023

Thanks @MatanBobi , I'd like to wait on @nickmccurdy 's review

@nickmccurdy
Copy link
Member

Working on this a bit more by reviewing nitpicks and Docusaurus docs. Have we done any visual comparisons yet or should I try?

@MatanBobi
Copy link
Member

Working on this a bit more by reviewing nitpicks and Docusaurus docs. Have we done any visual comparisons yet or should I try?

I made a quick browse (but haven't looked at all of the pages) and AFAIR, @timdeschryver also did.

@nickmccurdy
Copy link
Member

Great, thanks.

npx docusaurus-mdx-checker seems to be ok too, though the counts are off: slorber/docusaurus-mdx-checker#1

@timdeschryver
Copy link
Member Author

Working on this a bit more by reviewing nitpicks and Docusaurus docs. Have we done any visual comparisons yet or should I try?

@MatanBobi and myself have done some manual tests.
I don't know if visual tests are worth the effort because we don't do anything special, we just use the default setup. That being said, ideally we have some tests so if you want please feel free and go ahead.

npx docusaurus-mdx-checker seems to be ok too, though the counts are off

AFAIK, we're not using MDX, just plain markdown. So this doesn't affect us too much.
While upgrading another docs website I noticed we can also be explicit about this, and set the parser to markdown. https://docusaurus.io/docs/api/docusaurus-config#format

@nickmccurdy nickmccurdy changed the title update to docusaurus v3 chore: update to docusaurus v3 Nov 14, 2023
@nickmccurdy
Copy link
Member

nickmccurdy commented Nov 15, 2023

Working on this a bit more by reviewing nitpicks and Docusaurus docs. Have we done any visual comparisons yet or should I try?

@MatanBobi and myself have done some manual tests. I don't know if visual tests are worth the effort because we don't do anything special, we just use the default setup. That being said, ideally we have some tests so if you want please feel free and go ahead.

We can use visual regression tests for this. However, it requires setting up additional infrastructure, so I'd prefer to investigate after. For now we should be fine, I forgot you both tested manually.

@MatanBobi
Copy link
Member

MatanBobi commented Nov 15, 2023

AFAIK, we're not using MDX, just plain markdown. So this doesn't affect us too much. While upgrading another docs website I noticed we can also be explicit about this, and set the parser to markdown. https://docusaurus.io/docs/api/docusaurus-config#format

@timdeschryver I think we are using MDX features, I think this is an example, right?

@timdeschryver
Copy link
Member Author

What's the status with this PR, do we need to take further actions?

@nickmccurdy
Copy link
Member

I'm still working on it, hopefully some more next week.

@denisx
Copy link

denisx commented May 14, 2024

After updates, we can do this thing at root config ^_^

  headTags: [
    {
      tagName: 'link',
      attributes: {
        rel: 'preconnect',
        href: 'https://fonts.gstatic.com'
      },
    },
  ],

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.

None yet

4 participants