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: backport #9471, #9692, and #9695 changes in v3.1.1 docs #9804

Merged
merged 1 commit into from
Feb 1, 2024

Conversation

tats-u
Copy link
Contributor

@tats-u tats-u commented Jan 29, 2024

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

The changes by those PRs are only applied in Canary and has not been read by many people.

Test Plan

Compare versions between Canary and 3.1.1

https://deploy-preview-9804--docusaurus-2.netlify.app/docs/migration/v3/
https://deploy-preview-9804--docusaurus-2.netlify.app/docs/3.1.1/migration/v3/

https://deploy-preview-9804--docusaurus-2.netlify.app/docs/markdown-features/react/
https://deploy-preview-9804--docusaurus-2.netlify.app/docs/3.1.1/markdown-features/react/

Test links

Deploy preview: https://deploy-preview-9804--docusaurus-2.netlify.app

Related issues/PRs

#9471, #9692, and #9695

@tats-u tats-u requested a review from slorber as a code owner January 29, 2024 15:26
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jan 29, 2024
Copy link

netlify bot commented Jan 29, 2024

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 43ad16a
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/65b7c3b685e64500085095bc
😎 Deploy Preview https://deploy-preview-9804--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.

Copy link

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 59 🟢 98 🟢 100 🟢 100 🟠 89 Report
/docs/installation 🟠 88 🟢 98 🟢 100 🟢 100 🟠 89 Report
/docs/category/getting-started 🟠 75 🟢 100 🟢 100 🟢 90 🟠 89 Report
/blog 🟠 69 🟢 100 🟢 100 🟢 90 🟠 89 Report
/blog/preparing-your-site-for-docusaurus-v3 🟠 64 🟢 97 🟢 100 🟢 100 🟠 89 Report
/blog/tags/release 🟠 70 🟢 100 🟢 100 🟠 80 🟠 89 Report
/blog/tags 🟠 77 🟢 100 🟢 100 🟢 90 🟠 89 Report

@tats-u
Copy link
Contributor Author

tats-u commented Jan 30, 2024

Do I have to apply this change even to 3.0.1?

@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Feb 1, 2024
@slorber slorber changed the title Reflect #9471, #9692, and #9695 in 3.1.1 document docs: backport #9471, #9692, and #9695 changes in v3.1.1 docs Feb 1, 2024
@slorber
Copy link
Collaborator

slorber commented Feb 1, 2024

Thanks 👍

Do I have to apply this change even to 3.0.1?

You don't "have to", I assume many people will directly upgrade to 3.1 so it's not a big deal to not backport to all 3.x versions.

But I'm fine if you backport more as long as it applies to the version you backport the change to. So, up to you.

Going to move on and merge this directly.

@slorber slorber merged commit 09b2005 into facebook:main Feb 1, 2024
13 checks passed
@tats-u tats-u deleted the add-to-docs-3.1.1 branch February 1, 2024 11:07
@tats-u
Copy link
Contributor Author

tats-u commented Feb 4, 2024

I will make a choice not to reflect this in 3.0.x. It is just because it takes more work for a smaller impact, though.

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.

3 participants