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
Merged

Upgrade to docusaurus 2 #7785

merged 2 commits into from Oct 15, 2019

Conversation

@endiliey
Copy link
Contributor

@endiliey 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 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
Copy link
Contributor

@amyrlam 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
Copy link
Collaborator

@iansu 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
Copy link
Member

@yangshun 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
Copy link
Contributor Author

@endiliey endiliey commented Oct 12, 2019

@yangshun
Copy link
Member

@yangshun yangshun commented Oct 12, 2019

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

@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
@iansu
Copy link
Collaborator

@iansu iansu commented Oct 15, 2019

Looks great! Thanks!

@iansu iansu added this to the 3.3 milestone Oct 15, 2019
@endiliey
Copy link
Contributor Author

@endiliey 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 docusaurus branch Oct 15, 2019
@iansu
Copy link
Collaborator

@iansu iansu commented Oct 16, 2019

@endiliey Will do! Thanks again.

@ianschmitz ianschmitz removed this from the 3.3 milestone Oct 16, 2019
@ianschmitz ianschmitz added this to the 3.2.1 milestone Oct 16, 2019
@lock lock bot locked and limited conversation to collaborators Oct 21, 2019
@iansu iansu removed this from the 3.2.1 milestone Oct 23, 2019
@iansu iansu added this to the 3.3 milestone 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
No open projects
v3.3
  
Done
Linked issues

Successfully merging this pull request may close these issues.

None yet

6 participants