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

Refresh "What's Dagster+" #24007

Merged
merged 6 commits into from
Sep 5, 2024
Merged

Refresh "What's Dagster+" #24007

merged 6 commits into from
Sep 5, 2024

Conversation

jmsanders
Copy link
Contributor

@jmsanders jmsanders commented Aug 28, 2024

Aug 30th Lopp:

This PR has been updated to incorporate a few changes (sorry for the large size 😢 ):

  • The Dagster+ getting started topology now has two docs: "what's dagster+" and "getting started". This removes the dagster+ features doc.
    • Getting started focuses on being an actionable guide, without trying to re-describe a lot of what is in the product NUX. It relies fairly heavily on the adding a code location guide instead of replicating the content
    • What's Dagster+ builds off of Jordan's original content to explain briefly what Dagster+ is to a audience familiar with Dagster OSS, and also adds the short list of Dagster+ features (hence the removal of the features doc). This was also a natural place to put cross link out to parts of the dagster.io site as well as other guides
    • As a result, I decided to flatten the overall structure of the dagster-plus docs folder. "What's dagster+" and "getting started" are placed at the top level. Code requirements is moved to the deployment section, allowing us to remove the entire getting-started directory.
  • This PR also removes the "deployment types" doc in favor of the brief description of Serverless vs Hybrid in the getting started / whats dagster+ docs. Fixes the links as a result of this removal.
  • Adds the hybrid doc landing page, which takes the rest of Jordan's original content

@jmsanders jmsanders self-assigned this Aug 28, 2024
@graphite-app graphite-app bot added area: docs Related to documentation in general docathon labels Aug 28, 2024
@graphite-app graphite-app bot requested a review from cmpadden August 28, 2024 14:23
Copy link

graphite-app bot commented Aug 28, 2024

Graphite Automations

"docs-beta - Assign Reviewers" took an action on this PR • (08/28/24)

1 label was added and 1 reviewer was added to this PR based on Pedram Navid's automation.

Copy link

github-actions bot commented Aug 28, 2024

Deploy preview for dagster-docs ready!

Preview available at https://dagster-docs-9xsyr9fsf-elementl.vercel.app
https://jordan-agent-docs-refresh.dagster.dagster-docs.io

Direct link to changed pages:

@erinkcochran87 erinkcochran87 changed the title Refresh dagster+ getting started docs Refresh dagster+ getting started docs (DOC-367) Aug 28, 2024
Copy link
Contributor

@erinkcochran87 erinkcochran87 left a comment

Choose a reason for hiding this comment

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

This seems to fit more in line with What's Dagster+? over a getting started guide, IMO. The GS guide walks users through getting set up, like signing up, selecting a deployment type, adding a code location, etc.

I do also think we need a page that describes and compares Hybrid and Serverless, to make it easy for folks to decide which one to choose. This guide does a good job of giving the user a high-level look, but I think additional detail would be helpful so I wouldn't scrap the dagster-plus/deployment-types page just yet.

docs/docs-beta/docs/dagster-plus/getting-started.md Outdated Show resolved Hide resolved
@jmsanders jmsanders force-pushed the jordan/agent-docs-refresh branch 3 times, most recently from aeb2c25 to cf99eb5 Compare August 29, 2024 19:52
@jmsanders jmsanders force-pushed the jordan/agent-docs-refresh branch from cf99eb5 to f7f28c3 Compare August 29, 2024 21:21
@jmsanders jmsanders changed the title Refresh dagster+ getting started docs (DOC-367) Refresh "What's Dagster+" Aug 29, 2024
@jmsanders jmsanders assigned slopp and unassigned jmsanders Sep 3, 2024
@slopp slopp force-pushed the jordan/agent-docs-refresh branch from 12e37f9 to c21a1ae Compare September 5, 2024 14:11
@slopp slopp merged commit 41d44fb into master Sep 5, 2024
1 of 4 checks passed
@slopp slopp deleted the jordan/agent-docs-refresh branch September 5, 2024 14:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Related to documentation in general docathon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants