Skip to content

Upgrade to docusaurus 2 - #7785

Merged
iansu merged 2 commits into
react:masterfrom
endiliey:docusaurus
Oct 15, 2019
Merged

Upgrade to docusaurus 2#7785
iansu merged 2 commits into
react:masterfrom
endiliey:docusaurus

Conversation

@endiliey

@endilieyendiliey commented Oct 5, 2019

Copy link
Copy Markdown
Contributor

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

@yangshunyangshun left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 😅

Comment threaddocusaurus/docs/adding-bootstrap.md Outdated
Comment threaddocusaurus/website/src/pages/index.js
Comment threaddocusaurus/website/static/CNAME Outdated
@amyrlam

Copy link
Copy Markdown
Contributor

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

iansu commented Oct 9, 2019

Copy link
Copy Markdown
Contributor

@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
Copy Markdown
Contributor

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
Copy Markdown
ContributorAuthor

Updated. Check https://deploy-preview-7785--create-react-app.netlify.com/docs/getting-started/

image

image

@yangshun

Copy link
Copy Markdown
Contributor

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

@iansuiansu changed the title chore: upgrade to docusaurus 2Upgrade to docusaurus 2Oct 15, 2019
@iansu
iansu merged commit 9243305 into react:masterOct 15, 2019
@iansu

Copy link
Copy Markdown
Contributor

Looks great! Thanks!

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

Copy link
Copy Markdown
ContributorAuthor

@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 October 15, 2019 16:43
@iansu

Copy link
Copy Markdown
Contributor

@endiliey Will do! Thanks again.

@ianschmitzianschmitz modified the milestones: 3.3, 3.2.1Oct 16, 2019
@locklockBot locked and limited conversation to collaborators Oct 21, 2019
@iansuiansu modified the milestones: 3.2.1, 3.3Oct 23, 2019
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@endiliey@amyrlam@iansu@yangshun@ianschmitz@facebook-github-bot