Move 'tutorials' to 'docs/tutorials'

saihaj · Jan 25, 2022 · 29bf743 · 29bf743
1 parent d4bacc1
commit 29bf743
Show file tree

Hide file tree

Showing 14 changed files with 113 additions and 111 deletions.
diff --git a/.../authentication-and-express-middleware.md → .../authentication-and-express-middleware.md b/.../authentication-and-express-middleware.md → .../authentication-and-express-middleware.md
diff --git a/website/tutorials/basic-types.md → website/docs/tutorials/basic-types.md b/website/tutorials/basic-types.md → website/docs/tutorials/basic-types.md
diff --git a/website/tutorials/constructing-types.md → website/docs/tutorials/constructing-types.md b/website/tutorials/constructing-types.md → website/docs/tutorials/constructing-types.md
diff --git a/website/tutorials/express-graphql.md → website/docs/tutorials/express-graphql.md b/website/tutorials/express-graphql.md → website/docs/tutorials/express-graphql.md
diff --git a/website/tutorials/graphql-clients.md → website/docs/tutorials/graphql-clients.md b/website/tutorials/graphql-clients.md → website/docs/tutorials/graphql-clients.md
diff --git a/website/tutorials/hello.png → website/docs/tutorials/hello.png b/website/tutorials/hello.png → website/docs/tutorials/hello.png
diff --git a/website/tutorials/index.md → website/docs/tutorials/index.md b/website/tutorials/index.md → website/docs/tutorials/index.md
@@ -1,6 +1,5 @@
 ---
 title: Getting Started With GraphQL.js
-slug: /
 ---
 
 ## Prerequisites

diff --git a/...te/tutorials/mutations-and-input-types.md → ...cs/tutorials/mutations-and-input-types.md b/...te/tutorials/mutations-and-input-types.md → ...cs/tutorials/mutations-and-input-types.md
diff --git a/website/tutorials/object-types.md → website/docs/tutorials/object-types.md b/website/tutorials/object-types.md → website/docs/tutorials/object-types.md
diff --git a/website/tutorials/passing-arguments.md → website/docs/tutorials/passing-arguments.md b/website/tutorials/passing-arguments.md → website/docs/tutorials/passing-arguments.md
diff --git a/...ials/running-an-express-graphql-server.md → ...ials/running-an-express-graphql-server.md b/...ials/running-an-express-graphql-server.md → ...ials/running-an-express-graphql-server.md
diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -5,122 +5,32 @@ const path = require('path');
 const lightCodeTheme = require('prism-react-renderer/themes/github');
 const darkCodeTheme = require('prism-react-renderer/themes/dracula');
 
-/** @type {import('@docusaurus/types').DocusaurusConfig} */
+/** @type {import('@docusaurus/types').Config} */
 module.exports = {
   title: 'graphql-js',
   tagline: 'A reference implementation of GraphQL for JavaScript',
   url: 'https://graphql-js.graphql.org',
   baseUrl: '/',
-  onBrokenLinks: 'warn', // temporary need to find a way for typedoc generated docs to work
-  onBrokenMarkdownLinks: 'warn',
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'throw',
+  onDuplicateRoutes: 'throw',
   favicon: 'img/favicon.ico',
   organizationName: 'graphql',
   projectName: 'graphql-js',
-  themeConfig: {
-    navbar: {
-      title: 'graphql-js',
-      logo: {
-        alt: 'GraphQL Logo',
-        src: 'img/logo.svg',
-      },
-      items: [
-        {
-          type: 'doc',
-          docId: 'index',
-          position: 'left',
-          label: 'Tutorial',
-        },
-        {
-          href: 'https://github.com/graphql/graphql-js',
-          label: 'GitHub',
-          position: 'right',
-        },
-        {
-          to: 'api/graphql-js',
-          label: 'API',
-          position: 'left',
-        },
-      ],
-    },
-    footer: {
-      style: 'dark',
-      links: [
-        {
-          title: 'Docs',
-          items: [
-            {
-              label: 'Tutorial',
-              to: 'tutorials',
-            },
-          ],
-        },
-        {
-          title: 'Community',
-          items: [
-            {
-              label: 'Code of Conduct',
-              href: 'https://graphql.org/codeofconduct/',
-            },
-            {
-              label: 'Stack Overflow',
-              href: 'https://stackoverflow.com/questions/tagged/graphql-js',
-            },
-            {
-              label: 'Discord',
-              href: 'https://discord.graphql.org/',
-            },
-            {
-              label: 'Twitter',
-              href: 'https://twitter.com/graphql',
-            },
-            {
-              label: 'Upcoming Events',
-              href: 'https://graphql.org/community/upcoming-events/',
-            },
-          ],
-        },
-        {
-          title: 'More',
-          items: [
-            {
-              label: 'GraphQL JS Working Group',
-              href: 'https://github.com/graphql/graphql-js-wg',
-            },
-            {
-              label: 'GraphQL Foundation',
-              href: 'https://graphql.org/foundation',
-            },
-            {
-              label: 'GraphQL Spec',
-              href: 'https://spec.graphql.org',
-            },
-          ],
-        },
-      ],
-      copyright: `Copyright &copy; ${new Date().getFullYear()} <a href="https://graphql.org/foundation/" target="_blank" rel="noopener noreferrer">The GraphQL Foundation</a>. All rights reserved. <br/> For web site terms of use, trademark policy and general project policies please see&nbsp; <a href="https://lfprojects.org/" target="_blank" rel="noopener noreferrer">https://lfprojects.org</a>.`,
-    },
-    prism: {
-      theme: lightCodeTheme,
-      darkTheme: darkCodeTheme,
-    },
-  },
   presets: [
     [
       '@docusaurus/preset-classic',
-      {
-        pages: {
-          path: './src/pages',
-        },
+      /** @type {import('@docusaurus/preset-classic').Options} */
+      ({
         docs: {
-          path: './tutorials',
-          routeBasePath: 'tutorials',
           sidebarPath: require.resolve('./sidebars.js'),
-          editUrl: 'https://github.com/graphql/graphql-js/edit/main/docs/',
+          editUrl:
+            'https://github.com/graphql/graphql-js/edit/main/website/docs/',
         },
         theme: {
           customCss: require.resolve('./src/css/custom.css'),
         },
-      },
+      }),
     ],
   ],
   plugins: [
@@ -132,4 +42,94 @@ module.exports = {
       },
     ],
   ],
+  themeConfig:
+    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+    ({
+      navbar: {
+        title: 'graphql-js',
+        logo: {
+          alt: 'GraphQL Logo',
+          src: 'img/logo.svg',
+        },
+        items: [
+          {
+            type: 'doc',
+            docId: 'tutorials/index',
+            position: 'left',
+            label: 'Tutorial',
+          },
+          {
+            href: 'https://github.com/graphql/graphql-js',
+            label: 'GitHub',
+            position: 'right',
+          },
+          {
+            to: 'api/graphql-js',
+            label: 'API',
+            position: 'left',
+          },
+        ],
+      },
+      footer: {
+        style: 'dark',
+        links: [
+          {
+            title: 'Docs',
+            items: [
+              {
+                label: 'Tutorial',
+                to: 'docs/tutorials/',
+              },
+            ],
+          },
+          {
+            title: 'Community',
+            items: [
+              {
+                label: 'Code of Conduct',
+                href: 'https://graphql.org/codeofconduct/',
+              },
+              {
+                label: 'Stack Overflow',
+                href: 'https://stackoverflow.com/questions/tagged/graphql-js',
+              },
+              {
+                label: 'Discord',
+                href: 'https://discord.graphql.org/',
+              },
+              {
+                label: 'Twitter',
+                href: 'https://twitter.com/graphql',
+              },
+              {
+                label: 'Upcoming Events',
+                href: 'https://graphql.org/community/upcoming-events/',
+              },
+            ],
+          },
+          {
+            title: 'More',
+            items: [
+              {
+                label: 'GraphQL JS Working Group',
+                href: 'https://github.com/graphql/graphql-js-wg',
+              },
+              {
+                label: 'GraphQL Foundation',
+                href: 'https://graphql.org/foundation',
+              },
+              {
+                label: 'GraphQL Spec',
+                href: 'https://spec.graphql.org',
+              },
+            ],
+          },
+        ],
+        copyright: `Copyright &copy; ${new Date().getFullYear()} <a href="https://graphql.org/foundation/" target="_blank" rel="noopener noreferrer">The GraphQL Foundation</a>. All rights reserved. <br/> For web site terms of use, trademark policy and general project policies please see&nbsp; <a href="https://lfprojects.org/" target="_blank" rel="noopener noreferrer">https://lfprojects.org</a>.`,
+      },
+      prism: {
+        theme: lightCodeTheme,
+        darkTheme: darkCodeTheme,
+      },
+    }),
 };
diff --git a/website/sidebars.js b/website/sidebars.js
@@ -2,19 +2,19 @@
 
 module.exports = {
   tutorialSidebar: [
-    'index',
-    'running-an-express-graphql-server',
-    'graphql-clients',
-    'basic-types',
-    'passing-arguments',
-    'object-types',
-    'mutations-and-input-types',
-    'authentication-and-express-middleware',
+    'tutorials/index',
+    'tutorials/running-an-express-graphql-server',
+    'tutorials/graphql-clients',
+    'tutorials/basic-types',
+    'tutorials/passing-arguments',
+    'tutorials/object-types',
+    'tutorials/mutations-and-input-types',
+    'tutorials/authentication-and-express-middleware',
     {
       type: 'category',
       label: 'Advanced',
-      items: ['constructing-types'],
+      items: ['tutorials/constructing-types'],
     },
-    'express-graphql',
+    'tutorials/express-graphql',
   ],
 };
diff --git a/website/src/pages/index.jsx b/website/src/pages/index.jsx
@@ -14,7 +14,10 @@ function HomepageHeader() {
         <h1 className="hero__title">{siteConfig.title}</h1>
         <p className="hero__subtitle">{siteConfig.tagline}</p>
         <div className={styles.buttons}>
-          <Link className="button button--secondary button--lg" to="/tutorials">
+          <Link
+            className="button button--secondary button--lg"
+            to="/docs/tutorials"
+          >
             Get Started
           </Link>
         </div>