restructure

graphql · Nov 13, 2021 · 0547249 · 0547249
1 parent 797eb01
commit 0547249
Show file tree

Hide file tree

Showing 44 changed files with 26,252 additions and 33,258 deletions.
diff --git a/.babelrc.json b/.babelrc.json
@@ -4,6 +4,7 @@
     [
       "@babel/preset-env",
       { "bugfixes": true, "targets": { "node": "current" } }
-    ]
+    ],
+    "@docusaurus/core/lib/babel/preset"
   ]
 }
diff --git a/.gitignore b/.gitignore
@@ -14,3 +14,10 @@
 /denoDist
 /npm
 /deno
+/build
+.docusaurus
+.cache-loader
+.DS_Store
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/.prettierignore b/.prettierignore
@@ -7,7 +7,10 @@
 /denoDist
 /npm
 /deno
-
-# Docs Site
-/www/.docusaurus
-/www/build
+/build
+.docusaurus
+.cache-loader
+.DS_Store
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/docs/APIReference-Errors.md → docs-old/APIReference-Errors.md b/docs/APIReference-Errors.md → docs-old/APIReference-Errors.md
diff --git a/docs/APIReference-Execution.md → docs-old/APIReference-Execution.md b/docs/APIReference-Execution.md → docs-old/APIReference-Execution.md
diff --git a/docs/APIReference-GraphQL.md → docs-old/APIReference-GraphQL.md b/docs/APIReference-GraphQL.md → docs-old/APIReference-GraphQL.md
diff --git a/docs/APIReference-Language.md → docs-old/APIReference-Language.md b/docs/APIReference-Language.md → docs-old/APIReference-Language.md
diff --git a/docs/APIReference-TypeSystem.md → docs-old/APIReference-TypeSystem.md b/docs/APIReference-TypeSystem.md → docs-old/APIReference-TypeSystem.md
diff --git a/docs/APIReference-Utilities.md → docs-old/APIReference-Utilities.md b/docs/APIReference-Utilities.md → docs-old/APIReference-Utilities.md
diff --git a/docs/APIReference-Validation.md → docs-old/APIReference-Validation.md b/docs/APIReference-Validation.md → docs-old/APIReference-Validation.md
diff --git a/www/README.md → docs/README.md b/www/README.md → docs/README.md
diff --git a/www/src/css/custom.css → docs/src/css/custom.css b/www/src/css/custom.css → docs/src/css/custom.css
diff --git a/www/src/pages/index.js → docs/src/pages/index.js b/www/src/pages/index.js → docs/src/pages/index.js
@@ -4,7 +4,6 @@ import Layout from '@theme/Layout';
 import Link from '@docusaurus/Link';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import styles from './index.module.css';
-import HomepageFeatures from '../components/HomepageFeatures';
 
 function HomepageHeader() {
   const { siteConfig } = useDocusaurusContext();
@@ -30,9 +29,6 @@ export default function Home() {
       description="A reference implementation of GraphQL for JavaScript"
     >
       <HomepageHeader />
-      <main>
-        <HomepageFeatures />
-      </main>
     </Layout>
   );
 }
diff --git a/www/src/pages/index.module.css → docs/src/pages/index.module.css b/www/src/pages/index.module.css → docs/src/pages/index.module.css
diff --git a/.../authentication-and-express-middleware.md → .../authentication-and-express-middleware.md b/.../authentication-and-express-middleware.md → .../authentication-and-express-middleware.md
@@ -1,7 +1,6 @@
 ---
 title: Authentication and Express Middleware
 sidebar_label: Authentication & Middleware
-sidebar_position: 7
 ---
 
 It's simple to use any Express middleware in conjunction with `express-graphql`. In particular, this is a great pattern for handling authentication.

diff --git a/www/tutorials/basic-types.md → docs/tutorials/basic-types.md b/www/tutorials/basic-types.md → docs/tutorials/basic-types.md
@@ -1,6 +1,5 @@
 ---
 title: Basic Types
-sidebar_position: 3
 ---
 
 In most situations, all you need to do is to specify the types for your API using the GraphQL schema language, taken as an argument to the `buildSchema` function.

diff --git a/www/tutorials/constructing-types.md → docs/tutorials/constructing-types.md b/www/tutorials/constructing-types.md → docs/tutorials/constructing-types.md
@@ -1,7 +1,6 @@
 ---
 title: Constructing Types
 category: Advanced Guides
-sidebar_position: 8
 ---
 
 For many apps, you can define a fixed schema when the application starts, and define it using GraphQL schema language. In some cases, it's useful to construct a schema programmatically. You can do this using the `GraphQLSchema` constructor.

diff --git a/www/tutorials/express-graphql.md → docs/tutorials/express-graphql.md b/www/tutorials/express-graphql.md → docs/tutorials/express-graphql.md
@@ -1,6 +1,5 @@
 ---
 title: express-graphql
-sidebar_position: 9
 ---
 
 The `express-graphql` module provides a simple way to create an [Express](https://expressjs.com/) server that runs a GraphQL API.

diff --git a/www/tutorials/graphql-clients.md → docs/tutorials/graphql-clients.md b/www/tutorials/graphql-clients.md → docs/tutorials/graphql-clients.md
@@ -1,7 +1,6 @@
 ---
 title: GraphQL Clients
 category: GraphQL.js Tutorial
-sidebar_position: 2
 ---
 
 Since a GraphQL API has more underlying structure than a REST API, there are more powerful clients like [Relay](https://facebook.github.io/relay/) which can automatically handle batching, caching, and other features. But you don't need a complex client to call a GraphQL server. With `express-graphql`, you can just send an HTTP POST request to the endpoint you mounted your GraphQL server on, passing the GraphQL query as the `query` field in a JSON payload.

diff --git a/www/tutorials/index.md → docs/tutorials/index.md b/www/tutorials/index.md → docs/tutorials/index.md
@@ -1,6 +1,5 @@
 ---
 title: Getting Started With GraphQL.js
-sidebar_position: 0
 slug: /
 ---
 

diff --git a/www/tutorials/mutations-and-input-types.md → docs/tutorials/mutations-and-input-types.md b/www/tutorials/mutations-and-input-types.md → docs/tutorials/mutations-and-input-types.md
@@ -1,6 +1,5 @@
 ---
 title: Mutations and Input Types
-sidebar_position: 6
 ---
 
 If you have an API endpoint that alters data, like inserting data into a database or altering data already in a database, you should make this endpoint a `Mutation` rather than a `Query`. This is as simple as making the API endpoint part of the top-level `Mutation` type instead of the top-level `Query` type.

diff --git a/www/tutorials/object-types.md → docs/tutorials/object-types.md b/www/tutorials/object-types.md → docs/tutorials/object-types.md
@@ -1,9 +1,6 @@
 ---
 title: Object Types
-sidebar_position: 5
 category: GraphQL.js Tutorial
-permalink: /graphql-js/object-types/
-next: /graphql-js/mutations-and-input-types/
 ---
 
 In many cases, you don't want to return a number or a string from an API. You want to return an object that has its own complex behavior. GraphQL is a perfect fit for this.

diff --git a/www/tutorials/passing-arguments.md → docs/tutorials/passing-arguments.md b/www/tutorials/passing-arguments.md → docs/tutorials/passing-arguments.md
@@ -1,6 +1,5 @@
 ---
 title: Passing Arguments
-sidebar_position: 4
 ---
 
 Just like a REST API, it's common to pass arguments to an endpoint in a GraphQL API. By defining the arguments in the schema language, type checking happens automatically. Each argument must be named and have a type. For example, in the [Basic Types documentation](./basic-types.md) we had an endpoint called `rollThreeDice`:

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
@@ -1,7 +1,6 @@
 ---
 title: Running an Express GraphQL Server
 sidebar_label: Running Express + GraphQL
-sidebar_position: 1
 ---
 
 The simplest way to run a GraphQL API server is to use [Express](https://expressjs.com), a popular web application framework for Node.js. You will need to install two additional dependencies:

diff --git a/www/docusaurus.config.js → docusaurus.config.js b/www/docusaurus.config.js → docusaurus.config.js
@@ -1,4 +1,6 @@
+'use strict';
 const path = require('path');
+
 const lightCodeTheme = require('prism-react-renderer/themes/github');
 const darkCodeTheme = require('prism-react-renderer/themes/dracula');
 
@@ -11,8 +13,8 @@ module.exports = {
   onBrokenLinks: 'warn', // temporary need to find a way for typedoc generated docs to work
   onBrokenMarkdownLinks: 'warn',
   favicon: 'img/favicon.ico',
-  organizationName: 'graphql', // Usually your GitHub org/user name.
-  projectName: 'graphql-js', // Usually your repo name.
+  organizationName: 'graphql',
+  projectName: 'graphql-js',
   themeConfig: {
     navbar: {
       title: 'graphql-js',
@@ -34,7 +36,6 @@ module.exports = {
         },
         {
           to: 'api/graphql-js',
-          to: 'api',
           label: 'API',
           position: 'left',
         },
@@ -106,18 +107,17 @@ module.exports = {
     [
       '@docusaurus/preset-classic',
       {
+        pages: {
+          path: './docs/src/pages',
+        },
         docs: {
-          path: 'tutorials',
+          path: './docs/tutorials',
           routeBasePath: 'tutorials',
           sidebarPath: require.resolve('./sidebars.js'),
-          editUrl: 'https://github.com/graphql/graphql-js/edit/main/www/',
-        },
-        blog: {
-          showReadingTime: true,
-          editUrl: 'https://github.com/graphql/graphql-js/edit/main/www/blog/',
+          editUrl: 'https://github.com/graphql/graphql-js/edit/main/docs/',
         },
         theme: {
-          customCss: require.resolve('./src/css/custom.css'),
+          customCss: require.resolve('./docs/src/css/custom.css'),
         },
       },
     ],
@@ -126,7 +126,7 @@ module.exports = {
     [
       'docusaurus-plugin-typedoc-api',
       {
-        projectRoot: path.join(__dirname, '..'),
+        projectRoot: path.join(__dirname, '.'),
         packages: [{ path: '.', slug: 'graphql-js' }],
       },
     ],