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

Improve migration CLI #3520

Closed
slorber opened this issue Oct 2, 2020 · 4 comments
Closed

Improve migration CLI #3520

slorber opened this issue Oct 2, 2020 · 4 comments
Labels
closed: duplicate This issue or pull request already exists in another issue or pull request mlh Major League Hacking Fellowship proposal This issue is a proposal, usually non-trivial change

Comments

@slorber
Copy link
Collaborator

slorber commented Oct 2, 2020

💥 Proposal

We have a migration cli, to help migrating from v1 to v2, but it can still be improved a bit.

Note, we have a /v1-migrated deploy preview to review the current state of the migration cli: https://deploy-preview-3517--docusaurus-2.netlify.app/v1-migrated/

The idea would be to improve the migration cli so that we are almost able to migrate properly our own v1 website.

We likely won't reach 100% migration automation but there are still low-hanging fruits that we can work on to help our users migrate easily to v2.

@slorber slorber added proposal This issue is a proposal, usually non-trivial change mlh Major League Hacking Fellowship labels Oct 2, 2020
@utkarsh867
Copy link
Contributor

@slorber I'd like to take a shot at this issue.

It would be great to have some pointers on what migration features can I start with?

@slorber
Copy link
Collaborator Author

slorber commented Nov 9, 2020

Hi @utkarsh867

Sorry, forgot to link to the previous issue which has much more details: #3103

You'll also find PR comments interesting:
#3015

The migration cli is throw-away code as it won't be used for a very long time, but it wouldn't harm to clean it up a bit and make it easy to understand, as the current code is a bit messy, so you can start refactoring it a bit (without changing behavior).

The improvement I'd to see is to replicate the v1 comp library (Container, GridBlock, MarkdownBlock) using Infima, or just rendering fake data or whatever. The goal would be that we could migrate our own v1 site, and the pages would not render a blank screen like they currently do. See for example: https://deploy-preview-3517--docusaurus-2.netlify.app/v1-migrated/

Try to find a way to add this component library to v2 so that we render more page content. Even if it won't work in all situations, a hacky temporary solution could be helpful for users.

In general, any migration cli improvement idea is welcome, so let me know if you see useful things we could add.

Maybe you can try to find a community Docusaurus v1 site and propose a v2 migration to its owner?
This way you'd get a better understanding of the migration process, and be able to figure out which parts we can automate easily?

@utkarsh867
Copy link
Contributor

I'll be going through the issues you linked above and get back with some ideas that I might have!

Thanks!

@Josh-Cena
Copy link
Collaborator

Closing in favor of #3103

@Josh-Cena Josh-Cena added the closed: duplicate This issue or pull request already exists in another issue or pull request label Feb 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
closed: duplicate This issue or pull request already exists in another issue or pull request mlh Major League Hacking Fellowship proposal This issue is a proposal, usually non-trivial change
Projects
None yet
Development

No branches or pull requests

3 participants