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

feat: migrate Verdaccio.org to Docusaurus v2 and new design #2343

Merged
merged 23 commits into from
Jul 27, 2021

Conversation

semoal
Copy link
Member

@semoal semoal commented Jul 21, 2021

First of all, we should give thanks to @ploh007, for his amazing contribution gifting us this design.

Pending to-do's (In order)

  • Integrate Crowdin, I already know how to do this, just need some conversations with Juan (Api keys, and some details..).
  • Integrate Netlify, probably we can do this together too Juan, I want to introduce a netlify.toml, to add a cache of Docusaurus build, since under the hood uses Webpack 5 it contains persistent caching, which means consequent builds will be a lot faster. Example: https://github.com/facebook/docusaurus/blob/master/website/netlify.toml

Less relevant

  • Contact Algolia once released, to add the API_KEY for an amazing search experience.

Demo

Kapture.2021-07-21.at.20.35.38.mp4

@juanpicado
Copy link
Member

juanpicado commented Jul 21, 2021

@semoal could you commit something small, I just enabled netlify preview for this branch. Nevermind, I just read the comment 🙃

@juanpicado
Copy link
Member

Regarding Aligolia, we just need to PR here any future change

https://github.com/algolia/docsearch-configs/blob/master/configs/verdaccio.json

@semoal
Copy link
Member Author

semoal commented Jul 21, 2021

Regarding Aligolia, we just need to PR here any future change

https://github.com/algolia/docsearch-configs/blob/master/configs/verdaccio.json

They'll do it automatically for us, we just need to ping them

@semoal semoal force-pushed the new-website-ooo branch 4 times, most recently from 88a6f14 to ab506c2 Compare July 21, 2021 19:45
@semoal semoal force-pushed the new-website-ooo branch from ab506c2 to 782d163 Compare July 21, 2021 19:47
@github-actions
Copy link
Contributor

🚀 Netlify deployed trusting-mahavira-cc06c7 as draft

https://60faa6b057c493c1405a57ca--trusting-mahavira-cc06c7.netlify.app

@github-actions
Copy link
Contributor

github-actions bot commented Jul 23, 2021

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 85
🟢 Accessibility 97
🟢 Best practices 100
🟠 SEO 81

Lighthouse ran on https://610005fd3cc6931dd69db5ed--trusting-mahavira-cc06c7.netlify.app/

@github-actions
Copy link
Contributor

🚀 Netlify deployed trusting-mahavira-cc06c7 as draft

https://60fb3bf80caa6700a16fe2e0--trusting-mahavira-cc06c7.netlify.app

@semoal
Copy link
Member Author

semoal commented Jul 23, 2021

Well @juanpicado we're almost ready to 🚢.

Crowdin

Crowdin as you could check it's correctly imported with the new layout of translations, everything is translated as previously, there were a lot of buggy markdown's, I had to review one file per one haha. Also I've had to create a tool (https://github.com/semoal/mdx-localized-headings) for migrating translated headings with their correspondent ids, because translated documents didn't worked fine with the links. Now, everything will run smoothly.

Netlify

Also it's working perfectly fine, we should disable from the Netlify panel the auto build since we already do this operation. Also, I recommended changing the site name to verdaccio.netlify.com or something like that, in that way the deployment previews looks a bit nicer.

Known issues

  • Safari IOS, circles inside Twitter Carrousel are not working properly.
  • Safari IOS, lazy loaded iframes + twitter not working fine.

I'll look into this issues tomorrow early, in that way we can ship the website on Monday/Sunday whenever you want :)

@juanpicado
Copy link
Member

juanpicado commented Jul 24, 2021

Awesome !! I'll check today

  • ✅ Auto build disabled

@github-actions
Copy link
Contributor

🚀 Netlify deployed trusting-mahavira-cc06c7 as draft

https://60fe9f018d064d14674adfd7--trusting-mahavira-cc06c7.netlify.app

@github-actions
Copy link
Contributor

🚀 Netlify deployed trusting-mahavira-cc06c7 as draft

https://60fe9f27f218c412b1d420e6--trusting-mahavira-cc06c7.netlify.app

@semoal
Copy link
Member Author

semoal commented Jul 26, 2021

Screenshot 2021-07-26 at 14 13 44
Screenshot 2021-07-26 at 14 13 23

All the issues are fixed, we just need to add the Crowdin keys to secrets, and we're ready to go!

@semoal semoal force-pushed the new-website-ooo branch from 6e23614 to 069d307 Compare July 26, 2021 12:16
@github-actions
Copy link
Contributor

🚀 Netlify deployed trusting-mahavira-cc06c7 as draft

https://60fea815f4aee12a6449060b--trusting-mahavira-cc06c7.netlify.app

@github-actions
Copy link
Contributor

🚀 Netlify deployed trusting-mahavira-cc06c7 as draft

https://60fee9f7e0c9260b794c3918--trusting-mahavira-cc06c7.netlify.app

@juanpicado
Copy link
Member

@semoal I had to downgrade [email protected], there is an issue with the next minor.

@github-actions
Copy link
Contributor

🚀 Netlify deployed trusting-mahavira-cc06c7 as draft

https://60ff13acc14e19444aaa3a80--trusting-mahavira-cc06c7.netlify.app

juanpicado
juanpicado previously approved these changes Jul 26, 2021
Copy link
Member

@juanpicado juanpicado left a comment

Choose a reason for hiding this comment

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

LGTM 💯 great job, your contribution is huge 👏🏼
Tested: mobile, local build, deployment, all good by far.

@semoal
Copy link
Member Author

semoal commented Jul 26, 2021

LGTM 💯 great job, your contribution is huge 👏🏼

Tested: mobile, local build, deployment, all good by far.

Thanks to you Juan. Looking forward to contribute even more

@juanpicado
Copy link
Member

How do we solve the API_KEY for aligolia? Do I need to take an action here?

@semoal
Copy link
Member Author

semoal commented Jul 26, 2021

How do we solve the API_KEY for aligolia? Do I need to take an action here?

Probably the current one will work, let me ask to Algolia team.

@github-actions
Copy link
Contributor

🚀 Netlify deployed trusting-mahavira-cc06c7 as draft

https://60ffeb7eaefc14e509f47d93--trusting-mahavira-cc06c7.netlify.app

@semoal semoal marked this pull request as ready for review July 27, 2021 11:48
@github-actions
Copy link
Contributor

🚀 Netlify deployed trusting-mahavira-cc06c7 as draft

https://610005fd3cc6931dd69db5ed--trusting-mahavira-cc06c7.netlify.app

@semoal
Copy link
Member Author

semoal commented Jul 27, 2021

Ready to ship :shipit:

shipit

@semoal semoal merged commit a6b0d63 into master Jul 27, 2021
@semoal semoal deleted the new-website-ooo branch July 27, 2021 19:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants