Update website to use Docusaurus #4536

ericnakagawa · 2017-09-25T23:49:29Z

Summary

I have done a complete conversion of Jest's website to use Docusaurus.

Docusaurus provides all of the same features: crowdin integration, static page building, deployment to github, and algolia search.

ericnakagawa · 2017-09-26T00:22:59Z

I know what the error is. I'll resolve and send an update to this this PR.

The issue is the 'yarn build' script tries building the website, but looks for localized files and fails if they are missing.

codecov-io · 2017-09-26T14:17:58Z

Codecov Report

Merging #4536 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #4536   +/-   ##
=======================================
  Coverage   57.13%   57.13%           
=======================================
  Files         194      194           
  Lines        6565     6565           
  Branches        3        3           
=======================================
  Hits         3751     3751           
  Misses       2814     2814

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5049651...0f0d6a2. Read the comment docs.

thymikee · 2017-09-26T16:40:11Z

.circleci/config.yml

@@ -27,15 +27,18 @@ aliases:
      git config --global user.email "jest-bot@users.noreply.github.com"
      git config --global user.name "Website Deployment Script"
      echo "machine github.com login jest-bot password $GITHUB_TOKEN" > ~/.netrc
-      # crowdin install start
+      # install Docusaurus and generate file of English strings
+      cd website && npm install && npm run write-translations && cd ..


Can we install the deps w yarn instead?

Heck yeah! I'll swap that out now.

ericnakagawa · 2017-09-26T20:40:13Z

@thymikee Hi Mike, are you able to review and accept?

thymikee · 2017-09-26T20:41:09Z

I'll see what I can do!

thymikee · 2017-09-26T21:37:19Z

website/package.json

    "crowdin-upload": "crowdin-cli --config ../crowdin.yaml upload sources --auto-update -b master",
-    "crowdin-download": "crowdin-cli --config ../crowdin.yaml download -b master"
+    "crowdin-download": "crowdin-cli --config ../crowdin.yaml download -b master",


I don't see crowdin-download nor crowdin-upload used anywhere – is this expected and somehow used implicitly?

Also, README.md would use an update (e.g. port is outdated)

thymikee

It's hard for me to test it, because I'm not sure how to fully set this up locally – I don't have access to config keys, which makes all requests to /en et al. crash :<

thymikee · 2017-09-26T21:37:41Z

website/pages/en/help.js

+
+const translate = require('../../server/translate.js').translate;
+
+// const siteConfig = require(process.cwd() + "/siteConfig.js");


thymikee · 2017-09-26T21:43:47Z

website/server/feed.js

@@ -1,94 +0,0 @@
-/* eslint-disable sort-keys */


Aren't we providing RRS feed anymore?

Docusaurus doesn't have an RSS feature. I've made it a TODO.

New PR includes updated Docusaurus with RSS/Atom feeds.

thymikee · 2017-09-26T21:45:21Z

website/pages/en/help.js

+const Container = CompLibrary.Container;
+const GridBlock = CompLibrary.GridBlock;
+
+const translate = require('../../server/translate.js').translate;


Is this file generated somehow? It's deleted in this PR.

This is a file from Docusaurus.

Ok. I'd expect something like:

const {translate} = require('docusaurus/server');

but not sure how this thing works currently.

thymikee · 2017-09-26T21:46:25Z

website/siteConfig.js

+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */


License headers need to be adjusted to MIT

I can't adjust any additional licenses at this time.

@thymikee Great news Michał! Docusaurus is now licensed under MIT!

Still bsd here though

thymikee · 2017-09-26T21:47:39Z

website/siteConfig.js

+  ogImage: 'img/opengraph.png',
+  recruitingLink: 'https://crowdin.com/project/jest',
+  algolia: {
+    apiKey: '833906d7486e4059359fa58823c4ef56',


Should we expose Algolia API key?

Good point. This would be the same issue as you not having crowdin keys to test. I'll move the keys to Circle CI.

thymikee · 2017-09-26T21:48:49Z

website/static/css/custom.css

+}
+
+@media only screen and (min-width: 1500px) {
+}


Unused media queries

I've removed them.

orta · 2017-09-28T14:52:22Z

Impressive amount of deletions here 👍

ericnakagawa · 2017-10-06T17:43:55Z

@thymikee Please do another review. Hoping this update meets the expected standards! Preview -- https://build-mitsvvnzqs.now.sh/jest#

orta · 2017-10-06T17:46:34Z

Not sure if this is related, but the footer is using the wrong repo for the stars:

thymikee · 2017-10-06T18:09:36Z

@ericnakagawa I'm out for the weekend, but if I make some time, definitely have a look. Can I somehow build it locally?

ericnakagawa · 2017-10-10T05:36:44Z

@orta Thanks for the catch. Latest push has matching footer info + logos.
@thymikee You can manually run by running yarn from website, but you won't be able to sync with/to crowdin since that requires having Jest's crowdin keys.

Here's a fresh build from my machine: https://build-qbmkjpokcg.now.sh (currently uploading on airplane WiFi)

SimenB · 2017-10-10T05:51:24Z

website/.gitignore

@@ -0,0 +1,11 @@
+node_modules


why a nested gitignore?

SimenB · 2017-10-10T05:57:28Z

Loving it 😀

Only issue I found (other than the footer, which is fixed in latest commit) is that all the "Edit this doc" links 404 on github (they are missing the language). That might be fixed on the latest upload, it currently gives me 403.

One other thing (not sure if issue or not) is that all the links in the sidebar includes the hash #content. Doesn't seem to affect anything, but is sorta weird

SimenB · 2017-10-10T06:16:05Z

website/.gitignore

@@ -1,4 +1,3 @@
-node_modules


I meant the whole file, why not just stick the ignores you need in the root .gitignore?

@SimenB Ahh, I see. In event we ever break out the website into its own repo. For time being, I'll migrate the paths to the top level .gitignore.

ericnakagawa · 2017-10-10T06:18:04Z

@SimenB I removed the line from .gitignore and updated the edit doc path to include /en.

As for the sidebar links going to #content I've added this as an issue on the Docusaurus repo -- I'll review and fix there, then update in Jest once we decide. facebook/docusaurus#120

ericnakagawa · 2017-10-10T06:23:30Z

Due to my current internet connection I am unable to troubleshoot the breaking CI test.

SimenB · 2017-10-10T06:31:18Z

The CI failure is just prettier it seems like. So a yarn lint --fix should make everything nice and happy

ericnakagawa · 2017-10-10T15:57:09Z

@thymikee @SimenB Requesting a review! I had to manually re-run a job because of a segfault.

SimenB · 2017-10-10T16:03:20Z

Only thing I could spot was the comment about the license, nothing else I noticed (either in the code or clicking through https://build-qbmkjpokcg.now.sh/jest)

ericnakagawa · 2017-10-10T16:12:08Z

@SimenB Updated last file, also updated package.json to use latest docusaurus with MIT license throughout.

SimenB · 2017-10-10T16:13:33Z

website/siteConfig.js

-    image: '/jest/img/logos/facebook.png',
-    infoLink: 'https://code.facebook.com',
-    pinned: true,
+    caption: "Facebook",


your autoformat kicked in, I think

🤦‍♂️

ericnakagawa · 2017-10-10T16:58:57Z

Rebased and waiting for tests.

thymikee

looks good 👍

SimenB · 2017-10-10T20:50:46Z

Seeing as this PR moves all files out of en directory, I'm starting to wonder if 1fc503b#diff-c272134cac3612b41f93893bbaa34d24R254 was a mistake?

Updating sidebar Modifying files into Docusaurus format Slight header logo CSS change Ignore translated files and build directory Proper file locations for Docusaurus Move blog files to Docusaurus preferred location, modified crowdin to output /docs to /translated_pages, updated siteConfig.js Eslinting Docusaurus files Ignoring website/blog pages Linter fixes

Switch to use process.env.VAR for algolia key Switching crowdin upload/download to use yarn Circle CI fix Adding a delay to crowdin Fixing prettier errors Updating crowdin command in circle ci config Path fix

… to package.json

ericnakagawa · 2017-10-11T07:47:19Z

Rebased again after docs updated.

ericnakagawa · 2017-10-11T07:49:30Z

@SimenB Ah, I knew I had a reason for configuring it this way. I've rolled back the change.

Rebased, and ran through lint fixer.

We should be good to go!

github-actions · 2021-05-13T05:11:06Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

facebook-github-bot added the CLA Signed ✔️ label Sep 25, 2017

thymikee reviewed Sep 26, 2017

View reviewed changes

SimenB reviewed Oct 10, 2017

View reviewed changes

website/.gitignore Outdated

@@ -0,0 +1,11 @@

node_modules

Copy link

Member

SimenB Oct 10, 2017

Choose a reason for hiding this comment

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

why a nested gitignore?

SimenB reviewed Oct 10, 2017

View reviewed changes

thymikee approved these changes Oct 10, 2017

View reviewed changes

ericnakagawa added 4 commits October 11, 2017 08:46

Updating Circle config to remove website test

0df480a

Updating Circle config to auto-deploy website

bce144b

Add @deltice's config changes before website build, skip yarn build step

e7619ce

ericnakagawa added 13 commits October 11, 2017 08:46

Switch crowdin branch to master

5d4f26e

Updating siteconfig to @deltice's file

f49d9bf

Test crowdin branch

228e4d5

Switching Crowdin to master

c912751

Uses yarn to install, run, and deploy

0e396b6

Feedback fixes

7ae74b9

Switch to use process.env.VAR for algolia key Switching crowdin upload/download to use yarn Circle CI fix Adding a delay to crowdin Fixing prettier errors Updating crowdin command in circle ci config Path fix

Upgrading docusaurus to 1.0.0a40, adds an RSS/Atom feed

ca5b3d6

Update Docusaurus version

8984b18

Updated footer to reflect current footer. Updated footer logo.

46ce9b8

Fixes Edit this doc link, removes node_modules from .gitignore

b0dc41a

Move .gitignore rules to top level

6bcee90

Updating license file in siteConfig to MIT, added new Docusaurus beta…

43c32f6

… to package.json

Lint fix

3e4b3ef

Editing siteConfig.js to account for /docs not living in /docs/en

0f0d6a2

ericnakagawa merged commit 172c0b2 into jestjs:master Oct 11, 2017

github-actions bot locked as resolved and limited conversation to collaborators May 13, 2021


		const translate = require('../../server/translate.js').translate;

		// const siteConfig = require(process.cwd() + "/siteConfig.js");

Update website to use Docusaurus #4536

Update website to use Docusaurus #4536

Conversation

ericnakagawa commented Sep 25, 2017

ericnakagawa commented Sep 26, 2017

codecov-io commented Sep 26, 2017 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ericnakagawa commented Sep 26, 2017

thymikee commented Sep 26, 2017

thymikee Sep 26, 2017 • edited Loading

Choose a reason for hiding this comment

thymikee left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ericnakagawa Sep 26, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

orta commented Sep 28, 2017

ericnakagawa commented Oct 6, 2017

orta commented Oct 6, 2017

thymikee commented Oct 6, 2017

ericnakagawa commented Oct 10, 2017 • edited Loading

Choose a reason for hiding this comment

SimenB commented Oct 10, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ericnakagawa commented Oct 10, 2017

ericnakagawa commented Oct 10, 2017

SimenB commented Oct 10, 2017

ericnakagawa commented Oct 10, 2017

SimenB commented Oct 10, 2017

ericnakagawa commented Oct 10, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ericnakagawa commented Oct 10, 2017

thymikee left a comment

Choose a reason for hiding this comment

SimenB commented Oct 10, 2017

ericnakagawa commented Oct 11, 2017

ericnakagawa commented Oct 11, 2017

github-actions bot commented May 13, 2021

codecov-io commented Sep 26, 2017 •

edited

Loading

thymikee Sep 26, 2017 •

edited

Loading

ericnakagawa Sep 26, 2017 •

edited

Loading

ericnakagawa commented Oct 10, 2017 •

edited

Loading

SimenB commented Oct 10, 2017 •

edited

Loading