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

Updates to new docs "Build" section #26878

Merged
merged 56 commits into from
Jan 10, 2025
Merged

Updates to new docs "Build" section #26878

merged 56 commits into from
Jan 10, 2025

Conversation

neverett
Copy link
Contributor

@neverett neverett commented Jan 7, 2025

Summary & Motivation

Move missing content into "Build" section of new docs and edit for clarity.

Most content has been moved, although there are a few TODOs left, and a handful of empty files left over from before I got here that are a bit of a mystery.

We will also need to fix the code examples—in lots of places, the code was copy/pasted straight from the old docs mdx file, but those should be turned into<CodeExample>s (and the corresponding code moved into the correct snippets directory). I think we should get all the code samples in one sweep later, though, so we can concentrate on getting content moved as quickly as possible.

How I Tested These Changes

Local build.

Changelog

Insert changelog entry or delete this section.

Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
@neverett neverett added the area:docs-revamp Related to the revamp of the docs label Jan 7, 2025
@neverett neverett self-assigned this Jan 7, 2025
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Copy link

github-actions bot commented Jan 7, 2025

Deploy preview for dagster-docs-beta ready!

Preview available at https://dagster-docs-beta-q5nyssq5y-elementl.vercel.app

Direct link to changed pages:

Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
@neverett neverett changed the title Updates to new docs 'build' section Updates to new docs "Build" section Jan 7, 2025
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
…izing assets article, update links

Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Copy link

github-actions bot commented Jan 9, 2025

Deploy preview for dagster-docs ready!

Preview available at https://dagster-docs-tq0hkzdah-elementl.vercel.app
https://nikki-docs-new-build-docs.dagster.dagster-docs.io

Direct link to changed pages:

Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
… isn't documented

Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
@neverett neverett requested review from cmpadden and dehume January 10, 2025 02:11
Copy link
Contributor

@cmpadden cmpadden left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving to keep the ball rolling.

I can assist with python file=*.py -> CodeExample while you focus on content.

@neverett neverett merged commit 9dbb4ed into master Jan 10, 2025
2 of 3 checks passed
@neverett neverett deleted the nikki/docs/new-build-docs branch January 10, 2025 02:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:docs-revamp Related to the revamp of the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants