Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

chore: update to docusaurus v3 #1326

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

Open
timdeschryver wants to merge 12 commits into main
base: main
Choose a base branch
Loading
from docusaurus-v3
Open

chore: update to docusaurus v3 #1326

timdeschryver wants to merge 12 commits into main from docusaurus-v3

Conversation

Copy link
Member

@timdeschryver timdeschryver commented Oct 26, 2023

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.

Copy link

netlify bot commented Oct 26, 2023
edited
Loading

Deploy Preview for testing-library failed.

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

Copy link
Member

MatanBobi commented Oct 26, 2023
edited
Loading

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

Copy link
Member Author

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

MatanBobi and nickserv reacted with thumbs up emoji

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.

Copy link
Member Author

It can wait @MatanBobi

MatanBobi and nickserv reacted with thumbs up emoji

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?

Copy link
Member Author

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

Copy link
Member

nickserv commented Nov 3, 2023
edited
Loading

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!

Copy link
Member Author

timdeschryver commented Nov 3, 2023
edited
Loading

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

MatanBobi reacted with thumbs up emoji

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?

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.

Copy link
Member

Great, thanks.

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

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

@nickserv nickserv changed the title (削除) update to docusaurus v3 (削除ここまで) (追記) chore: update to docusaurus v3 (追記ここまで) Nov 14, 2023
Copy link
Member

nickserv commented Nov 15, 2023
edited
Loading

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.

Copy link
Member

MatanBobi commented Nov 15, 2023
edited
Loading

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 and nickserv reacted with thumbs up emoji

Copy link
Member Author

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

Copy link
Member

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

timdeschryver and MatanBobi reacted with thumbs up emoji

Copy link
Contributor

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
Reviewers

@MatanBobi MatanBobi MatanBobi approved these changes

@nickserv nickserv Awaiting requested review from nickserv

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /