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

Migrate Website to Docusaurus 2 Alpha #1110

Closed
khushal87 opened this issue Sep 6, 2022 · 7 comments
Closed

Migrate Website to Docusaurus 2 Alpha #1110

khushal87 opened this issue Sep 6, 2022 · 7 comments
Assignees
Labels
documentation Additional documentation requested wishlist Long-term wishlist feature requests

Comments

@khushal87
Copy link

Hi there! The Docusaurus team is currently developing Docusaurus 2 and is almost done with an MVP that doesn't include translations and versioning features, which means there's feature parity with your website's current usage of Docusaurus.

Docusaurus 2 brings about many improvements:

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

I will be helping you migrate and be the POC throughout the migration process. Let me know what you think!

cc @yangshun @wgao19

@khushal87
Copy link
Author

@lena-kashtelyan

@bernardbeckerman
Copy link
Contributor

Hi @khushal87, would you be able to provide some pointers on the migration procedure and its expected scope, as well as any benefits of doing so not mentioned above? Thanks!

@bernardbeckerman bernardbeckerman self-assigned this Sep 7, 2022
@yangshun
Copy link

yangshun commented Sep 8, 2022

@khushal87 the Docusaurus 2 migration task is super old and Docusaurus has already officially released v2... This task shouldn't be opened at all.

@yangshun
Copy link

yangshun commented Sep 8, 2022

@bernardbeckerman, for context, this is the original task: facebook/docusaurus#1834. It'd still be good to migrate to Docusaurus 2 eventually though, because Docusaurus 1 is no longer being maintained.

@Balandat
Copy link
Contributor

Balandat commented Sep 8, 2022

@yangshun we have a pretty funky setup (see e.g. this script) where we are doing versioning of sphinx docs that we render via docusaurus. We do this by essentially manually stripping out the body of sphinx html documents and inserting them into static content that is then integrated into the docusaurus page (see here).

My understanding at least in the past was that this wasn't straightforward to do with docusaurus v2 - maybe that has changed?

@khushal87
Copy link
Author

Hey @yangshun, so here I find that the docs are still using 1.7.2. So, migration to a stable version of Docusaurus 2.1.0 would be useful, right?

@lena-kashtelyan lena-kashtelyan added wishlist Long-term wishlist feature requests documentation Additional documentation requested labels Sep 13, 2022
@lena-kashtelyan
Copy link
Contributor

This is probably not happening soon and is already on the wishlist, so closing this for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Additional documentation requested wishlist Long-term wishlist feature requests
Projects
None yet
Development

No branches or pull requests

5 participants