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

[Docs] Add structure for remaining missing content (Dagster+) #26299

Merged
merged 51 commits into from
Dec 12, 2024

Conversation

neverett
Copy link
Contributor

@neverett neverett commented Dec 5, 2024

Summary & Motivation

  • Adds (mostly empty) directories and files for remaining Dagster+ content and adds TODOs and links to old content to be copied over
  • Makes metadata consistent across files so future docs contributors don't needlessly copy metadata that doesn't matter into new docs
  • Reorganizes deployment docs into "Deployment types", "Management", and "Migration" categories
  • Moves "Code locations" section to "Features"
  • Creates "CI/CD" section in "Features" and moves "Branch deployments" into it

How I Tested These Changes

Local and staging deployment

Changelog

@neverett neverett self-assigned this Dec 5, 2024
@neverett neverett added the area:docs-revamp Related to the revamp of the docs label Dec 5, 2024
@neverett neverett changed the title Add structure for remaining missing content [Docs] Add structure for remaining missing content Dec 6, 2024
@neverett neverett changed the title [Docs] Add structure for remaining missing content [Docs] Add structure for remaining missing content (Dagster+) Dec 9, 2024
Copy link

github-actions bot commented Dec 11, 2024

Deploy preview for dagster-docs-beta ready!

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

Direct link to changed pages:

Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
@neverett neverett marked this pull request as ready for review December 11, 2024 23:19
@neverett neverett requested a review from cmpadden December 11, 2024 23:37
@neverett
Copy link
Contributor Author

@cmpadden I realize this is another gigantic set of changes, but I think all that's needed here is a smoke test to make sure staging docs don't have any major issues.

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.

Nice, this really helps get things lined up for content. 👏

Heads-up that you'll want to add a [docs-beta] tag or something of that sort to the Changelog entries, or possibly not include them (up to you), as they'll end up in the Dagster release.

@neverett
Copy link
Contributor Author

cc @dehume so you can see what's in progress for the docs revamp

@neverett neverett merged commit 3d792fd into master Dec 12, 2024
2 of 3 checks passed
@neverett neverett deleted the nikki/docs/add-skeleton branch December 12, 2024 22:12
pskinnerthyme pushed a commit to pskinnerthyme/dagster that referenced this pull request Dec 16, 2024
…r-io#26299)

## Summary & Motivation

* Adds (mostly empty) directories and files for remaining Dagster+
content and adds TODOs and links to old content to be copied over
* Makes metadata consistent across files so future docs contributors
don't needlessly copy metadata that doesn't matter into new docs
* Reorganizes deployment docs into "Deployment types", "Management", and
"Migration" categories
* Moves "Code locations" section to "Features"
* Creates "CI/CD" section in "Features" and moves "Branch deployments"
into it

## How I Tested These Changes

Local and staging deployment

## Changelog

---------

Signed-off-by: nikki everett <[email protected]>
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.

3 participants