Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize beta docs (pt 1) #26019

Merged
merged 34 commits into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
bfe0c34
reorganize guides docs
neverett Nov 19, 2024
8d66614
don't ignore guides/build
neverett Nov 20, 2024
f69123d
reorganize 'build' section
neverett Nov 21, 2024
7104c37
reorganize automation section
neverett Nov 21, 2024
1f5dfab
reorganize monitoring section
neverett Nov 21, 2024
97d2bc2
reorganize test section
neverett Nov 21, 2024
a19da94
reorganize deployment section
neverett Nov 21, 2024
51b2554
fix numbering
neverett Nov 21, 2024
e658d0a
finish reorganizing build section
neverett Dec 2, 2024
00920e2
finish reorganizing automate section
neverett Dec 2, 2024
f5e218b
finish reorganizing monitor section
neverett Dec 2, 2024
dda6052
finish reorganizing test section
neverett Dec 2, 2024
9772543
missed one test doc
neverett Dec 3, 2024
b771ff7
finish reorganizing deploy section
neverett Dec 3, 2024
23c4286
Merge branch 'master' into nikki/docs/reorganize-guides-new-docs
neverett Dec 3, 2024
f4bc048
add glossary to sidebar (unlisted for now)
neverett Dec 3, 2024
b58fe6d
Merge branch 'master' into nikki/docs/reorganize-guides-new-docs
neverett Dec 3, 2024
d156b44
[docs-beta] rm source cargo for uv use (#26251)
cmpadden Dec 3, 2024
34c723a
Merge branch 'master' into nikki/docs/reorganize-guides-new-docs
neverett Dec 3, 2024
d41107b
Reorganize new Dagster+ docs (#26067)
neverett Dec 3, 2024
d58aef1
fix OSS deploy section index pages
neverett Dec 3, 2024
ebee003
fix code examples links
neverett Dec 3, 2024
c78e627
fix vale errors that it makes sense to fix
neverett Dec 3, 2024
c0f20ed
Merge branch 'master' into nikki/docs/reorganize-guides-new-docs
neverett Dec 4, 2024
3f39c82
Merge branch 'master' into nikki/docs/reorganize-guides-new-docs
neverett Dec 4, 2024
a925639
fix build and automate nav
neverett Dec 4, 2024
b7856fd
update README
neverett Dec 4, 2024
d138292
fix deploy section
neverett Dec 4, 2024
dea5cb3
Merge branch 'master' into nikki/docs/reorganize-guides-new-docs
neverett Dec 4, 2024
681ab4a
add index pages to remaining sections:
neverett Dec 4, 2024
a326790
remove reference section and clean up API docs
neverett Dec 5, 2024
5078a4f
move config docs to OSS deploy section, reorganize API docs
neverett Dec 5, 2024
7dfe820
make code locations section visible
neverett Dec 5, 2024
0a5ea60
Merge branch 'master' into nikki/docs/reorganize-guides-new-docs
neverett Dec 5, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/docs-beta/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

# Production
/build
!/docs/guides/build

# Generated files
.docusaurus
Expand Down
5 changes: 1 addition & 4 deletions docs/docs-beta/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ To install dependencies:
yarn install
```

**Note**: 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 Vale with:
Expand Down Expand Up @@ -44,7 +42,6 @@ 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.

Expand Down Expand Up @@ -116,7 +113,7 @@ To build the site for production:
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service. This also checks for any broken links in the documentation.
This command generates static content into the `build` directory and can be served using any static contents hosting service. This also checks for any broken links in the documentation. Note that you will need to store Algolia credentials in local environment variables to build the site for production.

## Deployment

Expand Down
2 changes: 1 addition & 1 deletion docs/docs-beta/docs/api/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_class_name: hidden
title: API Docs
title: API reference
---

import DocCardList from '@theme/DocCardList';
Expand Down
10 changes: 0 additions & 10 deletions docs/docs-beta/docs/concepts/assets.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/docs-beta/docs/concepts/assets/asset-checks.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/docs-beta/docs/concepts/assets/asset-dependencies.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/docs-beta/docs/concepts/assets/thinking-in-assets.md

This file was deleted.

This file was deleted.

3 changes: 0 additions & 3 deletions docs/docs-beta/docs/concepts/automation/schedules.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/docs-beta/docs/concepts/automation/sensors.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/docs-beta/docs/concepts/execution.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/docs-beta/docs/concepts/io-managers.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/docs-beta/docs/concepts/ops-jobs.md

This file was deleted.

6 changes: 0 additions & 6 deletions docs/docs-beta/docs/concepts/partitions.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/docs-beta/docs/concepts/resources.md

This file was deleted.

Empty file.
3 changes: 0 additions & 3 deletions docs/docs-beta/docs/concepts/sensors.md

This file was deleted.

8 changes: 0 additions & 8 deletions docs/docs-beta/docs/concepts/understanding-assets.md

This file was deleted.

6 changes: 0 additions & 6 deletions docs/docs-beta/docs/dagster-plus.md

This file was deleted.

This file was deleted.

7 changes: 0 additions & 7 deletions docs/docs-beta/docs/dagster-plus/access/rbac.md

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Code location history and rollbacks"
displayed_sidebar: "dagsterPlus"
sidebar_position: 4
sidebar_position: 100
sidebar_label: "Code location history and rollbacks"
---

Expand Down Expand Up @@ -54,4 +54,4 @@ If you notice an issue with newly deployed code, or your code fails to deploy su
## Next steps

- Learn more about [Code Locations](/dagster-plus/deployment/code-locations)
- Learn how to [Alert when a code location fails to load](/dagster-plus/deployment/alerts#alerting-when-a-code-location-fails-to-load)
- Learn how to [Alert when a code location fails to load](/dagster-plus/features/alerts#alerting-when-a-code-location-fails-to-load)
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Code locations"
displayed_sidebar: "dagsterPlus"
sidebar_position: 50
---

# Code locations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: 'Dagster+ code requirements'
displayed_sidebar: 'dagsterPlus'
sidebar_label: "Code requirements"
sidebar_position: 100
---

Your Dagster project must meet a few requirements to run in Dagster+.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Dagster+ settings"
unlisted: true
sidebar_position: 200
---

# Dagster+ settings
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: "Deployment settings"
displayed_sidebar: "dagsterPlus"
sidebar_label: "Settings"
sidebar_label: "Deployment settings"
unlisted: true
sidebar_position: 300
---

# Deployment settings
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Deployment types
unlisted: true
sidebar_position: 400
---

## Placeholder
# Deployment types
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Set environment variables using agent config"
displayed_sidebar: "dagsterPlus"
sidebar_position: 2
sidebar_position: 300
sidebar_label: "Set with agent config"
unlisted: true
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Built-in environment variables"
displayed_sidebar: "dagsterPlus"
sidebar_position: 3
sidebar_position: 100
sidebar_label: "Built-in variables"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Setting environment variables with the Dagster+ UI"
displayed_sidebar: "dagsterPlus"
sidebar_position: 1
sidebar_position: 200
sidebar_label: "Set with Dagster+ UI"
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
title: "Environment variables"
displayed_sidebar: "dagsterPlus"
unlisted: true
sidebar_position: 40
---

# Environment variables

import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Amazon ECS agents (Existing VPC)"
displayed_sidebar: "dagsterPlus"
sidebar_position: 11
sidebar_label: "Amazon ECS (existing)"
sidebar_position: 110
sidebar_label: "Amazon ECS (Existing VPC)"
unlisted: true
---
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Amazon ECS agents (New VPC)"
displayed_sidebar: "dagsterPlus"
sidebar_position: 10
sidebar_label: "Amazon ECS (new)"
sidebar_position: 100
sidebar_label: "Amazon ECS (New VPC)"
unlisted: true
---
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Docker agents"
displayed_sidebar: "dagsterPlus"
sidebar_position: 20
sidebar_position: 200
sidebar_label: "Docker"
unlisted: true
---
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Agents"
displayed_sidebar: "dagsterPlus"
sidebar_class_name: hidden
---

# Agents

import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Running Dagster+ agents on Kubernetes"
displayed_sidebar: "dagsterPlus"
sidebar_position: 30
sidebar_position: 300
sidebar_label: "Kubernetes"
---

Expand Down Expand Up @@ -95,7 +95,7 @@ An exhaustive list of settings is available [here](/dagster-plus/deployment/hybr

### Configure your agents to serve branch deployments

[Branch deployments](/dagster-plus/deployment/branch-deployments) are lightweight staging environments created for each code change. To configure your Dagster+ agent to manage them:
[Branch deployments](/dagster-plus/features/branch-deployments/index.mdx) are lightweight staging environments created for each code change. To configure your Dagster+ agent to manage them:

```yaml
# values.yaml
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Running a Dagster+ agent locally"
displayed_sidebar: "dagsterPlus"
sidebar_position: 40
sidebar_position: 600
sidebar_label: "Local"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Using multiple agents"
displayed_sidebar: "dagsterPlus"
sidebar_position: 50
sidebar_position: 400
unlisted: true
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Hybrid agent settings"
displayed_sidebar: "dagsterPlus"
sidebar_position: 60
sidebar_position: 700
sidebar_label: "Settings"
unlisted: true
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Dagster+ Hybrid architecture'
displayed_sidebar: 'dagsterPlus'
sidebar_position: 10
sidebar_position: 100
---

# Dagster+ Hybrid architecture
Expand Down
Loading
Loading