-
Notifications
You must be signed in to change notification settings - Fork 2k
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 #1190
Conversation
85dd002
to
e56f697
Compare
Very cool, many thanks! Is https://build-czv4ilhfc.now.sh/ an up-to-date preview of this PR? As you mentioned on #1171, some content is missing from the landing page. I think we still want it there:
|
Yes, that's the latest preview.
I'm working on it! |
@jvillard Latest preview here! |
a8a5403
to
3405ab8
Compare
@jvillard how does this look? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code looks good to me. Please add the copyright headers and we should be good to merge.
website/blog/2015-05-22-Infer-on-open-source-android-apps.md.md
Outdated
Show resolved
Hide resolved
4ecd7ca
to
e4045e6
Compare
Rewrote tex section with MDX. |
Any updates? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is amazing, thank you! I think the website looks much better overall in the new version.
There are a few regressions compared to the current version, but I have no idea how hard they would be to address.
- Is there a way to check for dead links? I spotted a few myself but it would be good to be somewhat confident that the migration didn't introduce dead links.
- I cannot find the documentation menu when I reduce the window size. In the previous version you can click to expand the navigation menu, eg to jump directly to "Analyzing apps or projects" under the "User Guide" heading. In the new version I can only access the headings themselves directly using the links in the global footer.
- The text in blog posts is smaller than it used to be, I'd prefer a larger font size if possible. Actually, the font size looks smaller on the whole site.
- I've listed some more in inline comments
- Do you have a list of features you weren't able to migrate and of textual changes made? This is the stuff I'm trying to track down in this code review but there's always a chance I missed some and it would be good to have at least a list of features that need to be re-evaluated (re-implement or leave dead), and a list of textual changes would make reviewing easier (mostly it would be nice if there were no textual changes at all in this PR and they were split in a separate one to make reviewing easier).
(note: I haven't reviewed all the files yet.)
@yangshun I just deleted and
|
@jvillard I fixed problems. I will push latest version when build issue is fixed. |
615fb21
to
c5f622a
Compare
@jvillard Published latest preview. (Sorry for late response...!) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jvillard has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
@imbsky has updated the pull request. Re-import the pull request |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry for taking forever to review, end of year + holidays got in the way.
I think we are almost ready to merge, thanks so much for your work! Noted a few more things inline, although now it looks like I should be able to fix them myself after the fact if you prefer.
@jvillard What do you use to deploy a static site? If you want to continue using GitHub Pages, I can set up a GitHub Action for deployment. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jvillard has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
@imbsky keeping gh-pages sounds good to me. A GitHub action to automatically publish the website would be awesome! |
I'm going to create a sandbox repository and see if my idea really works! |
@imbsky has updated the pull request. Re-import the pull request |
@jvillard This worked well in my environment. When merged into a master, it's automatically deployed to GitHub Pages. |
All environment variables are pre-configured in the Actions runner, so no extra configuration is required. |
@imbsky has updated the pull request. Re-import the pull request |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jvillard has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
Is there anything blocking merge? |
I was just about to write back, sorry for the delay. I'm doing the last checks that everything looks good. There are a few adjustments to make on our side due to URLs to issue types being different now. I also had to fix a few minor things like dead links and syncing with the current website changes that happened in the meantime. Other than that it looks great! I'm hoping to land this today. |
I'm unlikely to close this today so it will have to wait a few more days while I'm away. Again, sorry it's taking so long, we're almost ready on our end now. |
No worries! This amount of change is really annoying. I should have split it into a some small commits to make it easier to understand. I'm really sorry. |
Merged! Many thanks again for your amazing contribution. The website is not pushed to fbinfer.com yet because we need to switch the config from jekyll to static pages, but should be done soon. The GitHub action worked perfectly, thanks for that too! :) |
Hey @jvillard what does it mean by "to switch the config from jekyll to static pages"? Jekyll sites are static sites I believe. |
I think I can try to help you deploy the liv site. It should just be a matter of running the deploy command and pushing to the |
@yangshun The new website was already pushed to gh-pages by the GitHub action but that broke fbinfer.com (only showed a generic error "There is no website there" or somesuch from GitHub). I reverted the push manually (see gh-pages' history). Isn't the jekyll website generated on the fly by GitHub's infra from the markdown in the gh-pages branch? There's some setting to switch in our repo's configuration but I'm not an admin. |
Oh I see. I think GitHub has special handling for Jekyll sites such that no configuration is needed. However when we moved to Docusaurus we will need to manually enable the gh-pages. @JoelMarcey could you help out here? |
I created a task internally by the way: T63456491 |
Also it's very likely that I am completely wrong about how jekyll works! |
I suspect this will solve the problem. |
No, it was not correct. Hmm... Why doesn't it work... |
Probably there is something wrong with the Docusaurus config file. |
We need to manually allow gh-pages hosting from the repo settings, but only the Open Source team has access to that. |
It's working now thanks to 79bbf57. Many thanks!!! 🎉 🎉 |
Yay!! |
Context: #1171