DOC-595 Fix TODO links in new docs (#27232)

## Summary & Motivation Fixes links to placeholder `todo.md` file. ## How I Tested These Changes ## Changelog > Insert changelog entry or delete this section. --------- Signed-off-by: nikki everett <[email protected]>
dagster-io · Jan 21, 2025 · cecb481 · cecb481 · github-actions · Jan 21, 2025
1 parent c8ca34a
commit cecb481
Show file tree

Hide file tree

Showing 70 changed files with 267 additions and 564 deletions.
diff --git a/docs/docs-beta/CONTRIBUTING.md b/docs/docs-beta/CONTRIBUTING.md
@@ -1,8 +1,6 @@
-# Contributing
+# Contributing documentation
 
-## Migration from legacy docs
-
-There are some features in the previous docs that require changes to be made to work in the new Docusaurus-based documentation site.
+## Formatting
 
 ### PyObject references
 
@@ -27,71 +25,29 @@ After:
 />
 ```
 
-Note that the `method` property causes the build to break -- use `object` instead.
+Note that the `method` property causes the build to break -- use `object` instead, and prepend the class name to the method, if it is different from the module.
+
 
 ### Images
 
 #### Location
 
-Old images are in the [/docs/next/public/images](https://github.com/dagster-io/dagster/tree/master/docs/next/public/images) directory. You will need to copy them to [/docs/docs-beta/static/images](https://github.com/dagster-io/dagster/tree/master/docs/docs-beta/static/images).
+Images are located in [/docs/docs-beta/static/images](https://github.com/dagster-io/dagster/tree/master/docs/docs-beta/static/images).
 
 #### Formatting
 
-Before:
-
-```
-<Image
-  alt="Highlighted Redeploy option in the dropdown menu next to a code location in Dagster+"
-  src="/images/dagster-cloud/developing-testing/code-locations/redeploy-code-location.png"
-  width={1920}
-  height={284}
-/>
-```
-
-After:
-
 ```
 ![Highlighted Redeploy option in the dropdown menu next to a code location in Dagster+](/images/dagster-cloud/developing-testing/code-locations/redeploy-code-location.png)
 ```
 
 ### Notes
 
-Before:
-
-```
-<Note>This guide is applicable to Dagster+.</Note>
-```
-
-After:
-
 ```
 :::note
 This guide is applicable to Dagster+
 :::
 ```
 
-### Tabs
-
-Before:
-
-```
-<TabGroup>
-  <TabItem name="Amazon ECS">
-  ...
-  </TabItem>
-</TabGroup>
-```
-
-After:
-
-```
-<Tabs>
-  <TabItem value="Amazon ECS">
-  ...
-  </TabItem>
-</Tabs>
-```
-
 ### Header boundaries
 
 Previously, horizontal rules had to be defined between each level-two header: `---`.
@@ -100,26 +56,7 @@ This is no longer required, as the horizontal rule has been included in the CSS
 
 ### Reference tables
 
-Before:
-
-```
-<ReferenceTable>
-  <ReferenceTableItem propertyName="DAGSTER_CLOUD_DEPLOYMENT_NAME">
-    The name of the Dagster+ deployment. For example, <code>prod</code>.
-  </ReferenceTableItem>
-  <ReferenceTableItem propertyName="DAGSTER_CLOUD_IS_BRANCH_DEPLOYMENT">
-    If <code>1</code>, the deployment is a{" "}
-    <a href="/dagster-plus/managing-deployments/branch-deployments">
-      branch deployment
-    </a>
-    . Refer to the <a href="#reserved-branch-deployment-variables">
-      Branch Deployment variables section
-    </a> for a list of variables available in branch deployments.
-  </ReferenceTableItem>
-</ReferenceTable>
-```
-
-After:
+Use Markdown tables for reference tables.
 
 | Key                                  | Value                                                                                                     |
 | ------------------------------------ | --------------------------------------------------------------------------------------------------------- |
@@ -130,22 +67,9 @@ After:
 
 [Use HTML](https://www.markdownguide.org/hacks/#table-formatting) to add line breaks and lists to tables.
 
-### Whitespace via `{" "}`
-
-Forcing empty space using the `{" "}` interpolation is not supported, and must be removed.
-
 ### Prerequisites
 
-Before:
-
-```
-## Prerequisites
-
-- Install this
-- Configure that
-```
-
-After:
+Use `<details>` for prerequisites:
 
 ```
 <details>
@@ -157,7 +81,7 @@ After:
 </details>
 ```
 
-A prerequisites section should only include steps that the reader must take in order to run the example code in the article. Recommended reading should be formatted as a note:
+A prerequisites section should only include steps that the reader must take in order to successfully complete the steps in the documentation. Recommended reading should be formatted as a note:
 
 ```
 :::note
@@ -166,9 +90,8 @@ This article assumes familiarity with [assets](example-link).
 
 :::
 ```
----
 
-## Admonitions
+### Admonitions
 
 [Admonitions](https://docusaurus.io/docs/next/markdown-features/admonitions) are formatted as follows:
 
@@ -198,9 +121,7 @@ Here's a note.
 :::
 ```
 
----
-
-## Code examples
+### Code examples
 
 To include code snippets, use the following format:
 
@@ -226,9 +147,7 @@ This will run `pyright` on all new/changed files relative to the master branch.
 make quick_pyright
 ```
 
----
-
-## Diagrams
+### Diagrams
 
 You can use [Mermaid.js](https://mermaid.js.org/syntax/flowchart.html) to create diagrams. For example:
 
@@ -239,11 +158,9 @@ flowchart LR
 
 Refer to the [Mermaid.js documentation](https://mermaid.js.org/) for more info.
 
----
-
-## Tabs
+### Tabs
 
-[Tabs](https://docusaurus.io/docs/markdown-features/tabs) are formatted as follows:
+Tabs are formatted as follows:
 
 ```
 <Tabs>
@@ -256,4 +173,6 @@ Refer to the [Mermaid.js documentation](https://mermaid.js.org/) for more info.
 </Tabs>
 ```
 
-Use `**strong**` to emphasize content in tabs. Do not use Markdown headings, since that will generate confusing items in the right sidebar for the page.
+You can add labels to tags, customize headings, and sync tab choices with the `groupId` prop. For more information, see the [Docusaurus Tabs docs](https://docusaurus.io/docs/markdown-features/tabs).
+
+Use `**strong**` to emphasize content in tabs. Do not use Markdown headings, since those will generate confusing items in the right sidebar.
diff --git a/docs/docs-beta/README.md b/docs/docs-beta/README.md
@@ -1,7 +1,6 @@
 # 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.
+This is the home of the Dagster documentation. The documentation site is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
 
 ---
 
@@ -10,11 +9,12 @@ The documentation site is built using [Docusaurus](https://docusaurus.io/), a mo
 - `./src` contains custom components, styles, themes, and layouts.
 - `./content-templates` contains the templates for the documentation pages.
 - `./docs/` is the source of truth for the documentation.
-- `/examples/docs_beta_snippets/docs_beta_snippets/` contains all code examples for the documentation.
+- `/examples/docs_beta_snippets/docs_beta_snippets/` contains code examples for the documentation. Some code examples also live in `/examples/` and `/examples/docs_snippets/docs_snippets/`.
 
-The docs are broken down into the following sections:
+The docs are organized into the following sections:
 
-- Docs - includes content from [getting-started](./docs/getting-started/) and [guides](./docs/guides/)
+- Docs - includes content from [getting-started](./docs/getting-started/), [etl-pipeline-tutorial](./docs/etl-pipeline-tutorial/), [guides](./docs/guides/), and [about](./docs/about/)
+- [Tutorials](./docs/tutorials/)
 - [Integrations](./docs/integrations/)
 - [Dagster+](./docs/dagster-plus/)
 - [API reference](./docs/api/)
@@ -38,7 +38,7 @@ corepack enable
 yarn install
 ```
 
-It also uses [Vale](https://vale.sh/) to check for issues in the documentation.
+The docs site also uses [Vale](https://vale.sh/) to check for issues in the documentation.
 
 Install Vale with:
 
@@ -54,7 +54,7 @@ pip install vale
 
 ---
 
-## Local Development
+## Local development
 
 To start the local development server:
 
@@ -97,7 +97,7 @@ This command generates static content into the `build` directory and can be serv
 
 This site is built and deployed using Vercel.
 
-### API Documentation
+### API documentation
 
 API documentation is built in Vercel by overriding the _Build Command_ to the following:
 

diff --git a/docs/docs-beta/docs/dagster-plus/deployment/code-locations/dagster-cloud-yaml.md b/docs/docs-beta/docs/dagster-plus/deployment/code-locations/dagster-cloud-yaml.md
@@ -204,8 +204,7 @@ locations:
 
 For Dagster+ Hybrid deployments, the Python executable that is installed globally in the image, or the default Python executable on the local system if you use the local agent, will be used. To use a different Python executable, specify it using the `executable_path` setting. It can be useful to have different Python executables for different code locations.
 
-{/* For Dagster+ Serverless deployments, you can specify a different Python version by [following these instructions](/dagster-plus/deployment/deployment-types/serverless/runtime-environment#python-version). */}
-For Dagster+ Serverless deployments, you can specify a different Python version by [following these instructions](/todo).
+For Dagster+ Serverless deployments, you can specify a different Python version by [following these instructions](/dagster-plus/deployment/deployment-types/serverless/runtime-environment#use-a-different-python-version).
 
 ```yaml
 # dagster_cloud.yaml
@@ -231,9 +230,6 @@ If using Hybrid deployment, you can define additional configuration options for
 
 Refer to the configuration reference for your agent for more info:
 
-{/* - [Docker agent configuration reference](/dagster-plus/deployment/agents/docker/configuration-reference) */}
-- [Docker agent configuration reference](/todo)
-{/* - [Amazon ECS agent configuration reference](/dagster-plus/deployment/agents/amazon-ecs/configuration-reference) */}
-- [Amazon ECS agent configuration reference](/todo)
-{/* - [Kubernetes agent configuration reference](/dagster-plus/deployment/agents/kubernetes/configuration-reference) */}
-- [Kubernetes agent configuration reference](/todo)
+- [Docker agent configuration reference](/dagster-plus/deployment/deployment-types/hybrid/docker/configuration)
+- [Amazon ECS agent configuration reference](/dagster-plus/deployment/deployment-types/hybrid/amazon-ecs/configuration-reference)
+- [Kubernetes agent configuration reference](/dagster-plus/deployment/deployment-types/hybrid/kubernetes/configuration)
diff --git a/docs/docs-beta/docs/dagster-plus/deployment/code-locations/index.md b/docs/docs-beta/docs/dagster-plus/deployment/code-locations/index.md
@@ -122,7 +122,7 @@ Overall, the Git repository should contain:
             ...
     ```
 
-2. A [`dagster_cloud.yaml` file](/todo) with the settings for your code location. Here is an example:
+2. A [`dagster_cloud.yaml` file](/dagster-plus/deployment/code-locations/dagster-cloud-yaml) with the settings for your code location. Here is an example:
 
     ```yaml title="dagster_cloud.yaml
     locations:
@@ -234,4 +234,4 @@ The monorepo should have CI/CD configured to deploy your changes and add or upda
 ## Next steps
 
 - After adding a code location, you may want to setup access controls
-- You may want to add additional configuration to your code location. This configuration will vary by agent type, but see examples for [setting default resource limits for Kubernetes](/dagster-plus/deployment/deployment-types/hybrid/kubernetes) or [changing the IAM role for ECS](/todo).
+- You may want to add additional configuration to your code location. This configuration will vary by agent type, but see examples for [setting default resource limits for Kubernetes](/dagster-plus/deployment/deployment-types/hybrid/kubernetes) or [changing the IAM role for ECS](/dagster-plus/deployment/deployment-types/hybrid/amazon-ecs/configuration-reference).
diff --git a/docs/docs-beta/docs/dagster-plus/deployment/code-requirements.md b/docs/docs-beta/docs/dagster-plus/deployment/code-requirements.md
@@ -29,7 +29,7 @@ To work with Dagster+, your Dagster code:
 **Note**:
 
 - Different code locations can use different versions of Dagster
-- Dagster+ doesn't require a [`workspace.yaml` file](/todo). You can still create a `workspace.yaml` file to load your code in an open source Dagster webserver instance, but doing so won't affect how your code is loaded in Dagster+.
+- Dagster+ doesn't require a [`workspace.yaml` file](/guides/deploy/code-locations/workspace-yaml). You can still create a `workspace.yaml` file to load your code in an open source Dagster webserver instance, but doing so won't affect how your code is loaded in Dagster+.
 
 ## Hybrid deployment requirements
 

diff --git a/...ta/docs/dagster-plus/deployment/deployment-types/hybrid/docker/configuration.md b/...ta/docs/dagster-plus/deployment/deployment-types/hybrid/docker/configuration.md
@@ -7,8 +7,7 @@ sidebar_position: 200
 This guide is applicable to Dagster+.
 :::
 
-{/* This reference describes the various configuration options Dagster+ currently supports for [Docker agents](/dagster-plus/deployment/agents/docker/configuring-running-docker-agent). */}
-This reference describes the various configuration options Dagster+ currently supports for [Docker agents](/todo).
+This reference describes the various configuration options Dagster+ currently supports for Docker agents
 
 ---
 
@@ -34,8 +33,5 @@ The `container_context.docker.env_vars` property is a list, where each item can
 
 Refer to the following guides for more info about environment variables:
 
-{/* - [Dagster+ environment variables and secrets](/dagster-plus/managing-deployments/environment-variables-and-secrets) */}
-- [Dagster+ environment variables and secrets](/todo)
-{/* - [Using environment variables and secrets in Dagster code](/guides/dagster/using-environment-variables-and-secrets) */}
-- [Using environment variables and secrets in Dagster code](/todo)
-
+- [Dagster+ environment variables and secrets](/dagster-plus/deployment/management/environment-variables/)
+- [Using environment variables and secrets in Dagster code](/guides/deploy/using-environment-variables-and-secrets)
diff --git a/.../docs-beta/docs/dagster-plus/deployment/deployment-types/hybrid/docker/setup.md b/.../docs-beta/docs/dagster-plus/deployment/deployment-types/hybrid/docker/setup.md
@@ -13,8 +13,7 @@ In this guide, you'll configure and run a Docker agent. Docker agents are used t
 
 To complete the steps in this guide, you'll need:
 
-{/* - **Permissions in Dagster+ that allow you to manage agent tokens**. Refer to the [User permissions documentation](/dagster-plus/account/managing-users) for more info. */}
-- **Permissions in Dagster+ that allow you to manage agent tokens**. Refer to the [User permissions documentation](/todo) for more info.
+- **Permissions in Dagster+ that allow you to manage agent tokens**. Refer to the [User permissions documentation](/dagster-plus/features/authentication-and-access-control/rbac/user-roles-permissions/) for more info.
 - **To have Docker installed**
 - **Access to a container registry to which you can push images with Dagster code.** Additionally, your Docker agent must have the permissions required to pull images from the registry.
 
@@ -118,8 +117,5 @@ These credential helpers generally are configured in `~/.docker.config.json`. To
 
 Now that you've got your agent running, what's next?
 
-{/* - **If you're getting Dagster+ set up**, the next step is to [add a code location](/dagster-plus/managing-deployments/code-locations) using the agent. */}
-- **If you're getting Dagster+ set up**, the next step is to [add a code location](/todo) using the agent.
-
-{/* - **If you're ready to load your Dagster code**, refer to the [Adding Code to Dagster+](/dagster-plus/managing-deployments/code-locations) guide for more info. */}
-- **If you're ready to load your Dagster code**, refer to the [Adding Code to Dagster+](/todo) guide for more info.
+- **If you're getting Dagster+ set up**, the next step is to [add a code location](/dagster-plus/deployment/code-locations/) using the agent.
+- **If you're ready to load your Dagster code**, refer to the [Adding Code to Dagster+](/dagster-plus/deployment/code-locations/) guide for more info.