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

Dogfooding Docusaurus 2 #6793

Closed
yangshun opened this issue Apr 10, 2019 · 4 comments
Closed

Dogfooding Docusaurus 2 #6793

yangshun opened this issue Apr 10, 2019 · 4 comments

Comments

@yangshun
Copy link
Contributor

yangshun commented Apr 10, 2019

Is this a bug report?

No

Hi there! Docusaurus team here! We're currently developing Docusaurus 2 and are almost done with an MVP that doesn't include translations and versioning features, which means there's feature parity with CRA's current usage of Docusaurus. We'd like to dogfood v2 on CRA mainly to try out the migration process with existing v1 sites.

Docusaurus 2 brings about many improvements:

  • Client-side rendering with prerendering (site works without JavaScript!)
  • More flexible appearance - Customizable layouts, CSS modules, etc
  • Embeddable interactive React components within markdown via MDX

Downsides:

  • Documentation for v2 isn't quite ready yet, but given that CRA is not using too many features of Docusaurus, that's probably ok.
  • We use CSS variables in v2 and hence IE11 isn't supported. We plan to support a way to build an IE11 compatible version which replaces CSS variables entirely with its values, but it won't be arriving that soon. Update 4/16/19: This is done.

Would the CRA team be open to dogfooding v2? We would do the initial migration and help out with any issues that arise. There aren't too many breaking changes. If you all are agreeable, we plan to kick off the process in May. Let me know what you guys think!

cc @endiliey @JoelMarcey

@yangshun yangshun changed the title Dogfooding Docusaurus 3.0 Dogfooding Docusaurus 2 Apr 11, 2019
@amyrlam
Copy link
Contributor

amyrlam commented Apr 11, 2019

I think this sounds like a good idea and I can help. Could probably do most of it on a separate branch?

I can bring it up at the CRA meeting next week and report back...

@yangshun
Copy link
Contributor Author

Thanks @amyrlam! Keep me posted! 😄

@amyrlam amyrlam self-assigned this Apr 11, 2019
@iansu
Copy link
Contributor

iansu commented Apr 11, 2019

I'm on board with this. I agree that it would be nice to do this on a branch so we can test the new version out. Once v3 matches the current functionality we use we can roll it out.

@yangshun
Copy link
Contributor Author

We've launched the new CRA site with Docusaurus 2, closing this!

@lock lock bot locked and limited conversation to collaborators Nov 16, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

4 participants