[docs-beta] Use yarn

.github/workflows/build-docs-revamp.yml

@@ -0,0 +1,45 @@
+name: Deploy Docs Revamp
+on:
+  pull_request:
+    paths:
+      - docs/docs-beta
+      - .github/workflows/build-docs-revamp.yml
+  push:
+    branches:
+      - docs/revamp
+    paths:
+      - docs/docs-beta
+      - .github/workflows/build-docs-revamp.yml
+
+concurrency:
+  group: ${{ github.workflow}}-${{github.ref}}
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout docs/revamp branch
+        uses: actions/checkout@v4
+
+      - name: Publish Preview to Vercel
+        uses: amondnet/vercel-action@v25
+        with:
+          github-comment: ${{ true }}
+          vercel-token: ${{ secrets.VERCEL_TOKEN }}
+          vercel-org-id: ${{ secrets.VERCEL_ORG_ID }}
+          vercel-project-id: ${{ secrets.VERCEL_DOCS_NEXT_PROJECT_ID }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          scope: ${{ secrets.VERCEL_ORG_ID }}
+
+      - name: Publish to Vercel Production
+        uses: amondnet/vercel-action@v25
+        if: github.event_name == 'push' && github.ref == 'refs/heads/docs/revamp'
+        with:
+          vercel-token: ${{ secrets.VERCEL_TOKEN }}
+          vercel-org-id: ${{ secrets.VERCEL_ORG_ID }}
+          vercel-project-id: ${{ secrets.VERCEL_PROJECT_ID }}
+          vercel-args: "--prod"
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          scope: ${{ secrets.VERCEL_ORG_ID }}
+          alias-domains: dagster-docs-beta.dagster.dagster-docs.io

.github/workflows/build-docs.yml

@@ -18,7 +18,7 @@ on:
       - .github/workflows/build-docs.yml
 concurrency:
   # Cancel in-progress runs on same branch
-  group: ${{ github.ref }}
+  group: ${{ github.workflow}}-${{github.ref}}
   cancel-in-progress: true
 jobs:
   deploy:

.github/workflows/vale.yml

@@ -0,0 +1,35 @@
+name: Vale Docs
+on: 
+  pull_request:
+    paths:
+      - 'docs/**'
+      - .github/workflows/vale.yml
+  push:
+    branches:
+      - master
+      - docs-prod
+    paths:
+      - 'docs/**'
+      - .github/workflows/vale.yml
+
+concurrency:
+  group: ${{ github.workflow}}-${{github.ref}}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  vale:
+    name: runner / vale
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: errata-ai/vale-action@reviewdog
+        env:
+          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          files: '["docs-beta/docs"]'
+          vale_flags: "--config=docs/.vale.ini"
+          fail_on_error: true
+          reporter: github-pr-check

docs/.gitignore

@@ -1,3 +1,5 @@
 sphinx/_build/
 .env
 next/.env
+*.duckdb
+*.sqlite

docs/.vale.ini

@@ -0,0 +1,36 @@
+########################
+#         ABOUT        #
+########################
+
+# This file controls the Vale application, specifically what, where, and how it lints.
+
+# Vale config reference: https://vale.sh/docs/topics/config
+# INI syntax: https://ini.unknwon.io/docs/intro
+
+########################
+#    CORE SETTINGS     #
+########################
+
+StylesPath = "vale/styles"
+MinAlertLevel = suggestion
+Vocab = Dagster
+
+########################
+#  FORMAT ASSOCIATIONS #
+########################
+
+[formats]
+mdx = md
+
+########################
+#    FORMAT-SPECIFIC   #
+########################
+
+[*.{md,mdx,rst}]
+# Rules in this section are enforced in all md, mdx, and rst files
+
+[*.{md,mdx,rst}]
+BasedOnStyles = Dagster, Terms, Vale
+
+; Ignore all :py directives
+IgnorePatterns = (:py:[^`]+`[^`]+`)

docs/Makefile

@@ -1,4 +1,4 @@
-.PHONY: help
+.PHONY: help vale
 
 help:
 	@egrep -h '\s##\s' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m  %-30s\033[0m %s\n", $$1, $$2}'
@@ -27,3 +27,6 @@ mdx-format:  ## Format mdx files
 	cd next; yarn mdx-format
 
 mdx-full-format: docs_ruff mdx-format
+
+vale:
+	vale content sphinx

docs/docs-beta/.eslintrc.js

@@ -0,0 +1,28 @@
+module.exports = {
+  parser: '@babel/eslint-parser',
+  extends: ['plugin:react/recommended', 'plugin:@docusaurus/recommended', 'plugin:mdx/recommended'],
+  rules: {
+    'import/no-default-export': 'off',
+    'react/react-in-jsx-scope': 'off',
+  },
+  ignorePatterns: ['build'],
+  parserOptions: {
+    extensions: ['.md', '.mdx'], // Resolve .md files as .mdx
+    markdownExtensions: ['.md', '.markdown'], // Treat .md and .markdown files as plain markdown
+  },
+  overrides: [
+    {
+      files: ['*.md', '*.mdx'],
+      extends: 'plugin:mdx/recommended',
+      rules: {
+        'react/jsx-no-undef': 'off',
+        'react/no-unescaped-entities': 'off',
+      },
+    },
+  ],
+  settings: {
+    react: {
+      version: 'detect',
+    },
+  },
+};

docs/docs-beta/.gitignore

@@ -0,0 +1,29 @@
+# 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*
+*.sqlite
+
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

docs/docs-beta/.prettierignore

@@ -0,0 +1,4 @@
+node_modules
+.docusaurus
+build/
+docs/

docs/docs-beta/.prettierrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  bracketSpacing: false,
+  printWidth: 100,
+  singleQuote: true,
+  trailingComma: 'all',
+};

docs/docs-beta/.remarkrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  plugins: ['remark-frontmatter'],
+};

docs/docs-beta/.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "unifiedjs.vscode-mdx",
+    "esbenp.prettier-vscode",
+    "mrmlnc.vscode-remark",
+    "chrischinchilla.vale-vscode"
+  ]
+}

docs/docs-beta/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode"
+}

docs/docs-beta/.yarnrc.yml

@@ -0,0 +1,3 @@
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-4.4.0.cjs

docs/docs-beta/README.md

@@ -0,0 +1,64 @@
+# Dagster Docs - Beta
+
+This is the home of the new Dagster documentation. It is currently in beta and incomplete.
+The documentation site is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+The site uses [yarn](https://yarnpkg.com/) for package management. Run `yarn install` to install dependencies. Note that the yarn binary is checked in, so you do not need to install yarn yourself.
+
+It also uses [vale](https://vale.sh/) to check for issues in the documentation.
+
+Install value with:
+
+```bash
+brew install vale
+```
+
+### Overview of the docs
+
+Code in `./src` contains custom components, styles, themes, and layouts.
+Code `./content-templates` contains the templates for the documentation pages.
+Code in `./docs/` is the source of truth for the documentation.
+
+`./docs/code_examples` contains all code examples for the documentation.
+
+The docs are broken down into the following sections:
+
+- [Tutorials](./docs/tutorials/)
+- [Guides](./docs/guides/)
+- [Concepts](./docs/concepts/)
+
+`sidebar.ts` and `docusaurus.config.ts` are the main configuration files for the documentation.
+
+### Local Development
+
+To start the local development server:
+
+```bash
+yarn 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. Access the website at [http://localhost:3050](http://localhost:3050).
+
+To lint the documentation for issues:
+
+```bash
+yarn lint
+```
+
+To autofix linting issues and format with prettier:
+
+```bash
+yarn lint:fix
+```
+
+### Build
+
+To build the site for production:
+
+```bash
+yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.

docs/docs-beta/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};