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

docs: "Preparing your site for Docusaurus v3" blog post #9333

Merged
merged 40 commits into from
Sep 29, 2023

Conversation

slorber
Copy link
Collaborator

@slorber slorber commented Sep 21, 2023

Motivation

Blog post to explain to users what they can do ahead of time before attempting an upgrade to Docusaurus v3

https://deploy-preview-9333--docusaurus-2.netlify.app/blog/preparing-your-site-for-docusaurus-v3/

@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Sep 21, 2023
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Sep 21, 2023
@netlify
Copy link

netlify bot commented Sep 21, 2023

[V2]

Name Link
🔨 Latest commit b65d0bb
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/6516af70ec156900086fd857
😎 Deploy Preview https://deploy-preview-9333--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions
Copy link

github-actions bot commented Sep 21, 2023

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 89 🟢 97 🟢 92 🟢 100 🟠 89 Report
/docs/installation 🟠 78 🟢 98 🟢 92 🟢 100 🟠 89 Report

@github-actions
Copy link

github-actions bot commented Sep 21, 2023

Size Change: +1.05 kB (0%)

Total Size: 1.11 MB

Filename Size Change
website/build/assets/js/main.********.js 839 kB +1.05 kB (0%)
ℹ️ View Unchanged
Filename Size
website/.docusaurus/globalData.json 117 kB
website/build/assets/css/styles.********.css 113 kB
website/build/index.html 41.4 kB

compressed-size-action

@slorber slorber changed the title WIP - docs: "Preparing your site for Docusaurus v3" blog post docs: "Preparing your site for Docusaurus v3" blog post Sep 28, 2023
@slorber
Copy link
Collaborator Author

slorber commented Sep 28, 2023

Ready to review @Josh-Cena @OzakIOne, I'd like to publish it asap tomorrow.

Let me know if you see anything weird or unclear

@Josh-Cena
Copy link
Collaborator

Taking a look now.


This article will mostly focus on how to prepare your content for this new MDX version. We will also list a few other breaking changes that you can handle today.

![Preparing your site for Docusaurus v3 - social card](./img/social-card.png)
Copy link
Collaborator

Choose a reason for hiding this comment

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

The image is announcing v2.1. Is it a mistake?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Was planning to design it just before publishing ;)

slorber and others added 6 commits September 29, 2023 11:10
…index.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
…index.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
…index.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
…index.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
…index.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
…index.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
slorber and others added 21 commits September 29, 2023 11:24
…index.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
…index.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
…index.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
…index.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
…index.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
…index.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
…index.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
…index.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
…index.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
…index.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
…index.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
…index.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
@slorber
Copy link
Collaborator Author

slorber commented Sep 29, 2023

thanks for the review 👍

@slorber slorber merged commit e9e4635 into main Sep 29, 2023
9 of 10 checks passed
@slorber slorber deleted the slorber/prepare-for-docusaurus-v3 branch September 29, 2023 11:15
This was referenced Oct 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants