Skip to content

Commit cbf5a1a

Browse files
cmpaddenbrentjericho
authored andcommitted
[docs] re-organize file structure; remove docs-beta nomenclature (dagster-io#27631)
## Summary & Motivation See title. ## How I Tested These Changes ## Changelog NOCHANGELOG
1 parent 8108841 commit cbf5a1a

File tree

1,068 files changed

+636
-496
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,068 files changed

+636
-496
lines changed

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ on:
66
- docs-prod
77
paths:
88
- .github/workflows/build-docs-revamp.yml
9-
- docs/docs-beta/**
9+
- docs/**
1010
- examples/docs_beta_snippets/**
1111
- docs/sphinx/**
1212
pull_request:
1313
paths:
14-
- docs/docs-beta/**
14+
- docs/**
1515
- examples/docs_beta_snippets/**
1616
- .github/workflows/build-docs-revamp.yml
1717
- docs/sphinx/**
@@ -64,19 +64,19 @@ jobs:
6464

6565
- name: Lint Docs
6666
run: |
67-
cd docs/docs-beta
67+
cd docs
6868
yarn install
6969
yarn run lint
7070
7171
- name: Get changed docs files for PR comment
7272
if: ${{ github.event.pull_request }}
7373
run: |
74-
cd docs/docs-beta/docs
74+
cd docs/docs
7575
echo "Head ref is $GITHUB_HEAD_SHA"
7676
git fetch origin $GITHUB_HEAD_SHA
7777
# Compare the commit the branch is based on to its head to list changed files
7878
CHANGED_MD_FILES=$(git diff --name-only HEAD~${{ github.event.pull_request.commits }} "$GITHUB_HEAD_SHA" -- '*.md' '*.mdx')
79-
CHANGES_ENTRY=$(echo "$CHANGED_MD_FILES" | sed 's/\(index\)*\.mdx*$//' | sed 's/^docs\/docs-beta\/docs/- {{deploymentUrl}}/')
79+
CHANGES_ENTRY=$(echo "$CHANGED_MD_FILES" | sed 's/\(index\)*\.mdx*$//' | sed 's/^docs\/docs/- {{deploymentUrl}}/')
8080
CHANGES_ENTRY=$(echo -e "Preview available at {{deploymentUrl}}\n\nDirect link to changed pages:\n$CHANGES_ENTRY")
8181
echo "$CHANGES_ENTRY"
8282
# https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#multiline-strings

.github/workflows/vale.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@ name: Vale Docs
22
on:
33
pull_request:
44
paths:
5-
- 'docs/docs-beta/**'
5+
- 'docs/**'
66
- .github/workflows/vale.yml
77
push:
88
branches:
99
- master
1010
- docs-prod
1111
paths:
12-
- 'docs/docs-beta/**'
12+
- 'docs/**'
1313
- .github/workflows/vale.yml
1414

1515
concurrency:
@@ -29,7 +29,7 @@ jobs:
2929
env:
3030
REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
3131
with:
32-
files: '["docs/docs-beta/docs"]'
32+
files: '["docs/docs"]'
3333
vale_flags: "--config=docs/.vale.ini --minAlertLevel=warning"
3434
fail_on_error: true
3535
reporter: github-pr-review

.pre-commit-config.yaml

-6
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,6 @@ repos:
1414
args: [check, --fix, --exit-non-zero-on-fix]
1515
language: system
1616
pass_filenames: false
17-
- id: docs-mdx-format
18-
name: Format Docs
19-
language: system
20-
entry: bash -c "cd docs && make mdx-format"
21-
pass_filenames: false
22-
files: ^docs/content
2317

2418
# We do not use pyright's provided pre-commit hook because we need the environment management
2519
# supplied by `scripts/run-pyright.py`.

docs/.cursorrules

-32
This file was deleted.
File renamed without changes.

docs/.gitignore

+34-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,38 @@
11
sphinx/_build/
22
.env
3-
next/.env
4-
docs-beta/.docusaurus
3+
.docusaurus
54
*.duckdb
65
*.sqlite
6+
7+
# Dependencies
8+
/node_modules
9+
10+
# Production
11+
/build
12+
!/docs/guides/build
13+
!/versioned_docs/*/guides/build
14+
!/static/images/guides/build
15+
16+
# Generated files
17+
.docusaurus
18+
.cache-loader
19+
20+
# Misc
21+
.DS_Store
22+
.env.local
23+
.env.development.local
24+
.env.test.local
25+
.env.production.local
26+
27+
npm-debug.log*
28+
yarn-debug.log*
29+
yarn-error.log*
30+
*.sqlite
31+
32+
.yarn/*
33+
!.yarn/patches
34+
!.yarn/releases
35+
!.yarn/plugins
36+
!.yarn/sdks/**
37+
!.yarn/versions
38+
.pnp.*
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/.windsurfrules

-1
This file was deleted.
File renamed without changes.

docs/docs-beta/CONTRIBUTING.md renamed to docs/CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Note that the `method` property causes the build to break -- use `object` instea
3232

3333
#### Location
3434

35-
Images are located in [/docs/docs-beta/static/images](https://github.com/dagster-io/dagster/tree/master/docs/docs-beta/static/images).
35+
Images are located in [/docs/static/images](https://github.com/dagster-io/dagster/tree/master/docs/static/images).
3636

3737
#### Formatting
3838

@@ -129,7 +129,7 @@ To include code snippets, use the following format:
129129
<CodeExample path="path/to/file.py" />
130130
```
131131

132-
You can optionally include [additional properties](https://github.com/dagster-io/dagster/blob/master/docs/docs-beta/src/components/CodeExample.tsx#L6), such as `language`, `title`, `lineStart`, `lineEnd`, `startAfter`, and `endBefore`:
132+
You can optionally include [additional properties](https://github.com/dagster-io/dagster/blob/master/docs/src/components/CodeExample.tsx#L6), such as `language`, `title`, `lineStart`, `lineEnd`, `startAfter`, and `endBefore`:
133133

134134
```
135135
<CodeExample path="path/to/file.py" language="python" startAfter="start-after-comment" endBefore="end-before-comment" title="My example" />

docs/Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ mdx:
1414
tox -e sphinx-mdx
1515

1616
mdx_copy:
17-
cp -rf sphinx/_build/mdx/sections/api/apidocs/* docs-beta/docs/api/python-api/
17+
cp -rf sphinx/_build/mdx/sections/api/apidocs/* docs/api/python-api/
1818

1919
regenerate_cli_snippets:
2020
cd ../examples/docs_beta_snippets && tox -e docs_snapshot_update && echo "\nSnippets regenerated!"
File renamed without changes.
File renamed without changes.

docs/docs-beta/.gitignore

-32
This file was deleted.

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

-9
This file was deleted.

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

-3
This file was deleted.

0 commit comments

Comments
 (0)