Convert from docusaurus to nextra #4240

JoviDeCroock · 2024-10-15T18:14:08Z

This converts the existing docusaurus website to nextra just like https://github.com/graphql/graphql.github.io. This is a first step in moving the documentation here and having a redirect from graphql.org to graphql-js.org.

Not sure yet why codecov started failing 😅 when I run testonly:cover locally it tells me we are 100% covered.

WDYT about isolating the dependencies for the website in that folder? As seen in 9c7d615 this prevents the weird CI leaks that we're seeing

Resolves #4200

github-actions · 2024-10-15T18:14:32Z

Hi @JoviDeCroock, I'm @github-actions bot happy to help you with this PR 👋

Supported commands

Please post this commands in separate comments and only one per comment:

@github-actions run-benchmark - Run benchmark comparing base and merge commits for this PR
@github-actions publish-pr-on-npm - Build package from this PR and publish it on NPM

yaacovCR · 2024-10-16T09:42:44Z

WDYT about isolating the dependencies for the website in that folder? As seen in 9c7d615 this prevents the weird CI leaks that we're seeing

Sounds fine, ideally, we wouldn’t need to do that but we can always try to fix it later

.github/workflows/ci.yml

yaacovCR · 2024-10-17T21:02:21Z

I get the following error when running npm run build locally, not sure if it is an error on my side. npm run dev works.

Just a note that this PR does not (yet) have the extra context at https://graphql-js.org missing at https://graphql.org/graphql-js => add additional content from graphql-js repository graphql.github.io#1782 => presumably that is for a later PR
Existing graphql-js.org version of website has a typedoc view of the API (https://graphql-js.org/api/) => just noting that to open up discussion for whether we will be doing something similar

JoviDeCroock · 2024-10-18T06:34:51Z

@yaacovCR I think I found what could have been causing the issue for you 😅 I purposefully didn't add the new content yet to make the PR easier to review, currently it's basically a copy of the content within graphql.org and moving the website to its own lockfile. Regarding typedoc, I am personally not a big fan as TypeScript provides more value here.

package.json

website/theme.config.tsx

website/package.json

website/next.config.mjs

.gitignore

website/pages/graphql-clients.mdx

website/pages/index.mdx

website/theme.config.tsx

website/pages/object-types.mdx

Co-authored-by: Yaacov Rydzinski <yaacovCR@gmail.com>

vercel · 2024-10-19T18:17:21Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
graphql-js	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 19, 2024 6:22pm

This converts the existing docusaurus website to nextra just like https://github.com/graphql/graphql.github.io. This is a first step in moving the documentation here and having a redirect from graphql.org to graphql-js.org. Not sure yet why codecov started failing 😅 when I run `testonly:cover` locally it tells me we are 100% covered. WDYT about isolating the dependencies for the website in that folder? As seen in graphql@9c7d615 this prevents the weird CI leaks that we're seeing Resolves graphql#4200 --------- Co-authored-by: Yaacov Rydzinski <yaacovCR@gmail.com>

This converts the existing website to nextra just like https://github.com/graphql/graphql.github.io. This is a first step in moving the documentation here and having a redirect from graphql.org to graphql-js.org. Not sure yet why codecov started failing 😅 when I run `testonly:cover` locally it tells me we are 100% covered. WDYT about isolating the dependencies for the website in that folder? As seen in graphql@9c7d615 this prevents the weird CI leaks that we're seeing Resolves graphql#4200 --------- Co-authored-by: Yaacov Rydzinski <yaacovCR@gmail.com>

JoviDeCroock requested a review from a team as a code owner October 15, 2024 18:14

JoviDeCroock force-pushed the nextra-conversion branch 5 times, most recently from c32daa0 to cc1aed1 Compare October 16, 2024 06:02

Convert from docusaurus to nextra

74547b6

JoviDeCroock force-pushed the nextra-conversion branch 6 times, most recently from f952870 to ee4e1df Compare October 16, 2024 08:35

JoviDeCroock added the PR: docs 📝 label Oct 16, 2024

JoviDeCroock force-pushed the nextra-conversion branch from ee4e1df to 9c7d615 Compare October 16, 2024 09:03

JoviDeCroock mentioned this pull request Oct 17, 2024

add additional content from graphql-js repository graphql/graphql.github.io#1782

Closed

yaacovCR reviewed Oct 17, 2024

View reviewed changes

.github/workflows/ci.yml Outdated Show resolved Hide resolved

yaacovCR reviewed Oct 17, 2024

View reviewed changes

.github/workflows/ci.yml Show resolved Hide resolved

JoviDeCroock force-pushed the nextra-conversion branch from 9c7d615 to 27892ff Compare October 18, 2024 06:33

yaacovCR reviewed Oct 18, 2024

View reviewed changes

package.json Outdated Show resolved Hide resolved

yaacovCR approved these changes Oct 18, 2024

View reviewed changes

JoviDeCroock force-pushed the nextra-conversion branch 4 times, most recently from 7bc980b to 31e2ed2 Compare October 18, 2024 08:01