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 documentation to Docusaurus v2 #670

Closed
wants to merge 133 commits into from

Conversation

teikjun
Copy link
Contributor

@teikjun teikjun commented Jun 24, 2020

Summary

Hi there! As discussed in #669, we would like to migrate Litho's documentation website to Docusaurus 2.

Docusaurus 2 brings about many improvements:

  • Client-side rendering with prerendering (site renders without JavaScript!)
  • Embeddable interactive React components within markdown via MDX
  • Docusaurus sites are React apps built with modern Javascript ecosystem tooling

In this PR, we've migrated the documentation over to Docusaurus 2 (in /website directory) while leaving the /docs directory intact.
We've matched the design of the original site as much as possible, so that the transition will be smooth for users of Litho.

Changelog

Migrate documentation website from Jekyll to Docusaurus v2

Test Plan

The test site is up! https://litho-deploy.vercel.app

@Drewbi and I are looking to improve the documentation site further based on your feedback.
Please let us know what you think! :)

cc @yangshun

@facebook-github-bot
Copy link
Contributor

@teikjun has updated the pull request. Re-import the pull request

@facebook-github-bot
Copy link
Contributor

@teikjun has updated the pull request. Re-import the pull request

@colriot
Copy link
Contributor

colriot commented Jun 30, 2020

I've noticed that Litho version is not pulled in correctly, like:

implementation 'com.facebook.litho:litho-core:{{site.litho-version}}'
implementation 'com.facebook.litho:litho-widget:{{site.litho-version}}'

{site.litho-version} was a part of the website config before, to be able to update it in one place during the release

@facebook-github-bot
Copy link
Contributor

@teikjun has updated the pull request. Re-import the pull request

@facebook-github-bot
Copy link
Contributor

@teikjun has updated the pull request. Re-import the pull request

@facebook-github-bot
Copy link
Contributor

@teikjun has updated the pull request. Re-import the pull request

@facebook-github-bot
Copy link
Contributor

@teikjun has updated the pull request. Re-import the pull request

@teikjun
Copy link
Contributor Author

teikjun commented Jul 2, 2020

I've noticed that Litho version is not pulled in correctly, like:

implementation 'com.facebook.litho:litho-core:{{site.litho-version}}'
implementation 'com.facebook.litho:litho-widget:{{site.litho-version}}'

{site.litho-version} was a part of the website config before, to be able to update it in one place during the release

We've just fixed this issue!
As before, the versions can be updated in one place versionConfig.js (found in the website's root directory).
The updated version will be reflected across all docs! :)

@facebook-github-bot
Copy link
Contributor

@teikjun has updated the pull request. Re-import the pull request

@JoelMarcey
Copy link
Contributor

How are we on this? Are we good to go with the migration?

@Drewbi
Copy link

Drewbi commented Jul 8, 2020

Should be all complete unless there’s any changes you can think of.

Copy link
Contributor

@facebook-github-bot facebook-github-bot left a comment

Choose a reason for hiding this comment

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

@astreet has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

@muraziz
Copy link
Contributor

muraziz commented Jul 8, 2020

I fixed internal errors, we should be ready for migration. @JoelMarcey could you advice on how to migrate, I pinged you on the phabricator diff

@muraziz
Copy link
Contributor

muraziz commented Jul 9, 2020

Commit is merged, now we should be able to redirect website to new one. Will update here when it happens.

@facebook-github-bot
Copy link
Contributor

@muraziz merged this pull request in 727b801.

@colriot
Copy link
Contributor

colriot commented Aug 4, 2020

@Drewbi @teikjun just for your info: we didn't just shelve your effort, we are currently working on integrating this into our internal docs publishing mechanism (this won't be Github Pages eventually, so we don't waste time on making Docusaurus work with them)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants