graphiti 2.0.0.beta.2 → 2.0.0.beta.4

data/package.json

@@ -1,6 +1,7 @@
 {
   "name": "graphiti",
-  "version": "1.4.0",
+  "private": true,
+  "version": "0.0.0-development",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/graphiti-api/graphiti.git"
@@ -15,9 +16,9 @@
   },
   "devDependencies": {
     "semantic-release-rubygem": "^1.2.0",
-    "semantic-release": "^19.0.3",
-    "@semantic-release/changelog": "^6.0.1",
-    "@semantic-release/git": "^10.0.1" 
+    "semantic-release": "^25.0.8",
+    "@semantic-release/changelog": "^7.0.0",
+    "@semantic-release/git": "^11.0.1"
   },
   "release": {
     "branches": [

data/website/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

data/website/README.md

@@ -0,0 +1,43 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+## Installation
+
+```bash
+npm install
+```
+
+**Note**: feel free to use the package manager of your choice.
+
+## Local Development
+
+```bash
+npm run start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+## Build
+
+```bash
+npm run build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+## Deployment
+
+Using SSH:
+
+```bash
+USE_SSH=true npm run deploy
+```
+
+Not using SSH:
+
+```bash
+GIT_USER=<Your GitHub username> npm run deploy
+```
+
+If you are using GitHub Pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

data/website/docusaurus.config.js

@@ -0,0 +1,141 @@
+// @ts-check
+const {themes} = require('prism-react-renderer');
+
+/** @type {import('@docusaurus/types').Config} */
+const config = {
+  title: 'Graphiti',
+  tagline: 'Stylish Graph APIs',
+  favicon: 'img/favicon.ico',
+
+  url: 'https://www.graphiti.dev',
+  // Project pages serve this repo under /graphiti/ until the domain moves
+  // here from graphiti-api.github.io, so the deploy sets DOCS_BASE_URL.
+  baseUrl: process.env.DOCS_BASE_URL || '/',
+  organizationName: 'graphiti-api',
+  projectName: 'graphiti',
+
+  onBrokenLinks: 'warn',
+  markdown: {hooks: {onBrokenMarkdownLinks: 'warn'}},
+
+  presets: [
+    [
+      'classic',
+      /** @type {import('@docusaurus/preset-classic').Options} */
+      ({
+        docs: {
+          // markdown lives at the repo root, next to the code it documents
+          path: '../docs',
+          routeBasePath: '/',
+          sidebarPath: require.resolve('./sidebars.js'),
+          editUrl: 'https://github.com/graphiti-api/graphiti/tree/main/website/',
+          // Unversioned docs serve at the root, and would otherwise be
+          // labelled "Next" in the dropdown. Once `npm run docusaurus
+          // docs:version 2.0` cuts a version, that becomes the root and the
+          // working copy moves to /next.
+          versions: {current: {label: '2.0 beta'}},
+        },
+        blog: false,
+        theme: {customCss: require.resolve('./src/css/custom.css')},
+      }),
+    ],
+  ],
+
+  plugins: [
+    [
+      '@docusaurus/plugin-client-redirects',
+      {
+        // The 1.x Jekyll site served /guides/* and /cookbooks/*, and early 2.0
+        // drafts served /quickstart and /cheatsheet. Keep those URLs alive.
+        // Nothing under /1.13/ is touched: that is the frozen 1.x site.
+        redirects: [
+          {from: ['/quickstart'], to: '/getting-started/first-api'},
+          {from: ['/cheatsheet', '/guides', '/guides/index'], to: '/'},
+          {from: ['/guides/overview'], to: '/concepts/overview'},
+          {from: ['/guides/why'], to: '/reference/why'},
+          {from: ['/guides/vandal'], to: '/reference/vandal'},
+          {from: ['/guides/upgrading', '/guides/upgrading-2-0', '/reference/upgrading-2-0', '/upgrading/controllers', '/upgrading/testing', '/upgrading/persistence-hooks', '/upgrading/exception-handling', '/upgrading/belongs-to-linkage', '/upgrading/without-rails'], to: '/upgrading'},
+          {from: ['/guides/getting-started/installation'], to: '/getting-started/installation'},
+
+          {from: ['/guides/concepts/resources'], to: '/concepts/resources'},
+          {from: ['/guides/concepts/endpoints'], to: '/concepts/endpoints'},
+          {from: ['/guides/concepts/links'], to: '/concepts/links'},
+          {from: ['/guides/concepts/backends-and-models'], to: '/concepts/backends-and-models'},
+          {from: ['/guides/concepts/testing'], to: '/topics/testing'},
+          {from: ['/guides/concepts/debugging'], to: '/topics/debugging'},
+          {from: ['/guides/concepts/error-handling'], to: '/topics/error-handling'},
+          {from: ['/guides/concepts/remote-resources', '/cookbooks/remote-resources'], to: '/topics/remote-resources'},
+
+          // Cookbook stubs that never had content now point at the real pages
+          {from: ['/cookbooks/authorization'], to: '/topics/authorization'},
+          {from: ['/cookbooks/caching'], to: '/topics/caching'},
+          {from: ['/cookbooks/etags'], to: '/topics/etags'},
+          {from: ['/cookbooks/json_attributes'], to: '/topics/json-attributes'},
+          {from: ['/cookbooks/openstruct-models'], to: '/topics/openstruct-models'},
+          {from: ['/cookbooks/without-activerecord'], to: '/topics/without-activerecord'},
+          {from: ['/cookbooks/customizing-sideloads'], to: '/topics/customizing-sideloads'},
+          {from: ['/cookbooks/hopping-relationships'], to: '/topics/hopping-relationships'},
+
+          {from: ['/js/introduction'], to: '/js'},
+          {
+            from: [
+              '/js/reads/index',
+              '/js/reads/filtering',
+              '/js/reads/sorting',
+              '/js/reads/pagination',
+              '/js/reads/fieldsets',
+              '/js/reads/includes',
+              '/js/reads/nested-queries',
+              '/js/reads/statistics',
+            ],
+            to: '/js/reads',
+          },
+          {
+            from: [
+              '/js/writes/index',
+              '/js/writes/validations',
+              '/js/writes/dirty-tracking',
+              '/js/writes/nested',
+              '/js/writes/deferred',
+            ],
+            to: '/js/writes',
+          },
+        ],
+      },
+    ],
+  ],
+
+  themeConfig: {
+    colorMode: {
+      // Dark for a first-time visitor. Flip respectPrefersColorScheme to true
+      // to follow the OS setting instead, in which case defaultMode only
+      // applies when the visitor has no preference either way. Once someone
+      // uses the navbar toggle their choice is remembered and wins over both.
+      defaultMode: 'dark',
+      respectPrefersColorScheme: false,
+    },
+    navbar: {
+      title: 'Graphiti',
+      logo: {alt: 'Graphiti', src: 'img/logo.png'},
+      items: [
+        {
+          type: 'docsVersionDropdown',
+          position: 'right',
+          // 1.x stays as the original Jekyll site, frozen under /1.13.
+          //
+          // target '_self' is required. Without it the router treats this as
+          // an in-app route, finds no match, and renders the 404 page even
+          // though the file is served fine.
+          dropdownItemsAfter: [
+            {href: '/1.13/', label: '1.x', target: '_self'},
+          ],
+        },
+        {href: 'https://github.com/graphiti-api/graphiti', label: 'GitHub', position: 'right'},
+        {href: 'https://discord.gg/wgqkMBsSRV', label: 'Discord', position: 'right'},
+      ],
+    },
+    footer: {style: 'dark', copyright: `Graphiti is released under the MIT license.`},
+    prism: {theme: themes.github, darkTheme: themes.dracula, additionalLanguages: ['ruby', 'bash', 'json', 'http']},
+  },
+};
+
+module.exports = config;