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

Upgrade to docusaurus 2 #7785

Merged
merged 2 commits into from Oct 15, 2019

Conversation

@endiliey
Copy link
Contributor

endiliey commented Oct 5, 2019

Motivation

Hello there, as discussed in #6793 we would like to dogfood docusaurus v2 for CRA. The development experience for v2 is much better because client side rendering is also enabled. The website is also seems to be very performant (its a single page app now but also staticly rendered for SEO)

It's better to test it from netlify preview https://deploy-preview-7785--create-react-app.netlify.com/

Probably what's missing is the "Edit" button on each docs page and a collapsible sidebar. That will come in .alpha.26 instead

Preview
dark
doc
home

cc @yangshun

Copy link
Member

yangshun left a comment

Wow this is awesome. It's nice that there were so few Docusaurus changes to be made. I'm not sure if the CRA maintainers would want to separate out the Markdown changes vs the Docusaurus changes. Might be cleaner, but this looks fine to me.

Approved from the Docusaurus side!

cc @amyrlam here's our long overdue PR 😅

docusaurus/docs/adding-bootstrap.md Outdated Show resolved Hide resolved
docusaurus/website/src/pages/index.js Show resolved Hide resolved
docusaurus/website/static/CNAME Outdated Show resolved Hide resolved
@amyrlam

This comment has been minimized.

Copy link
Collaborator

amyrlam commented Oct 5, 2019

hey @yangshun @endiliey! nice to see you on github again, docusaurus 2 is looking 💅

looks great to me, will let @iansu do the official approval

@iansu

This comment has been minimized.

Copy link
Collaborator

iansu commented Oct 9, 2019

@yangshun this looks great! Are there any known limitations or bugs other than the two that you mentioned? Do you think this is ready to replace our current docs?

@yangshun

This comment has been minimized.

Copy link
Member

yangshun commented Oct 9, 2019

We're working on the missing docs features (in fact we have them built in facebook/docusaurus#1817 and facebook/docusaurus#1818)! We'll release a new version very soon and help you guys upgrade then.

Other than that, maybe the CSS will not render well in IE11 due to usage of CSS variables (but we intend to fix it in future). But that's about it!

@endiliey

This comment has been minimized.

Copy link
Contributor Author

endiliey commented Oct 12, 2019

@yangshun

This comment has been minimized.

Copy link
Member

yangshun commented Oct 12, 2019

@iansu for your review. There's feature parity with V1 now. Thank you!

@yangshun yangshun referenced this pull request Oct 12, 2019
3 of 23 tasks complete
@iansu iansu changed the title chore: upgrade to docusaurus 2 Upgrade to docusaurus 2 Oct 15, 2019
@iansu iansu merged commit 9243305 into facebook:master Oct 15, 2019
15 checks passed
15 checks passed
facebook.create-react-app Build #20191012.2 succeeded
Details
facebook.create-react-app (Behavior LinuxNode10) Behavior LinuxNode10 succeeded
Details
facebook.create-react-app (Behavior LinuxNode8) Behavior LinuxNode8 succeeded
Details
facebook.create-react-app (Behavior MacNode10) Behavior MacNode10 succeeded
Details
facebook.create-react-app (Behavior MacNode8) Behavior MacNode8 succeeded
Details
facebook.create-react-app (Installs LinuxNode10) Installs LinuxNode10 succeeded
Details
facebook.create-react-app (Installs LinuxNode8) Installs LinuxNode8 succeeded
Details
facebook.create-react-app (Kitchensink LinuxNode10) Kitchensink LinuxNode10 succeeded
Details
facebook.create-react-app (Kitchensink LinuxNode8) Kitchensink LinuxNode8 succeeded
Details
facebook.create-react-app (KitchensinkEject LinuxNode10) KitchensinkEject LinuxNode10 succeeded
Details
facebook.create-react-app (KitchensinkEject LinuxNode8) KitchensinkEject LinuxNode8 succeeded
Details
facebook.create-react-app (OldNode) OldNode succeeded
Details
facebook.create-react-app (Simple LinuxNode10) Simple LinuxNode10 succeeded
Details
facebook.create-react-app (Simple LinuxNode8) Simple LinuxNode8 succeeded
Details
netlify/create-react-app/deploy-preview Docs deploy preview succeeded
Details
@iansu

This comment has been minimized.

Copy link
Collaborator

iansu commented Oct 15, 2019

Looks great! Thanks!

@iansu iansu added this to the 3.3 milestone Oct 15, 2019
@endiliey

This comment has been minimized.

Copy link
Contributor Author

endiliey commented Oct 15, 2019

@iansu

ping me and @yangshun when there is an issue with the website. That's the purpose of our dogfooding. You can also try to look into looking for contributors to revamp the landing page to be nicer as well since the site is a SPA now.

@endiliey endiliey deleted the endiliey:docusaurus branch Oct 15, 2019
@iansu

This comment has been minimized.

Copy link
Collaborator

iansu commented Oct 16, 2019

@endiliey Will do! Thanks again.

@ianschmitz ianschmitz modified the milestones: 3.3, 3.2.1 Oct 16, 2019
@lock lock bot locked and limited conversation to collaborators Oct 21, 2019
@iansu iansu modified the milestones: 3.2.1, 3.3 Oct 23, 2019
@iansu iansu added this to In progress in v3.3 via automation Oct 23, 2019
@iansu iansu moved this from In progress to Done in v3.3 Oct 23, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
v3.3
  
Done
6 participants
You can’t perform that action at this time.