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] [essentials] - Dagster UI #16526

Merged
merged 33 commits into from
Sep 21, 2023
Merged

Conversation

erinkcochran87
Copy link
Contributor

@erinkcochran87 erinkcochran87 commented Sep 14, 2023

Summary & Motivation

This PR (unintentionally) refactors the Dagster UI concept page. This was pretty out of date and incomplete, so I took the opportunity to spiff it up. Specifically, it:

  • Updates all existing screenshots and removes some old/unused ones
  • Adds the Overview page/factory floor (link)
  • Moves Jobs to the bottom of the page (in line with Essentials v1)
  • In Assets, adds Global asset lineage (link)
  • In Runs, adds info about event and compute logs (link)
  • Splits Schedules and sensors into two dedicated sections. Also adds info about the details page for both concepts. (link)
  • Adds a section for the Resources tab (link)
  • In Jobs, adds the Runs and Partitions tabs (runs, partitions)
  • In Deployment, add remaining tabs for OSS and Cloud deployments (link)

How I Tested These Changes

👀 , local

@erinkcochran87 erinkcochran87 added the area: docs Related to documentation in general label Sep 18, 2023
@erinkcochran87
Copy link
Contributor Author

erinkcochran87 commented Sep 18, 2023

@jamiedemaria I wound up doing an overhaul of this, since it was absurdly out of date and incomplete. I left a list of stuff I changed in the PR description, along with preview links to those changes - that should make it easier to review. I didn't go for exhaustive, but instead obvious and/or painful gaps that needed to be filled.

Copy link
Contributor

@jamiedemaria jamiedemaria left a comment

Choose a reason for hiding this comment

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

this is beautiful! I really like it. A couple things:

  • I think getting Josh's feedback would be good - he might have ideas of specific features to point out on some pages, or other flows through the UI that are worth discussing
  • I might be weird in this, but my primary way of navigating around the UI is by using the side nav. I don't think the page is lacking because it doesn't talk about the side nav, but it could be worth mentioning. It'd be worth double checking what the status of the "kill the sidenav" project is before investing time writing anything about it.
  • how time consuming would it be to put boxes around the "how to get there" buttons in the screenshots to make them jump out even more? if it's more than like 10min of work, or if it's something that would have to get manually redone all the time, then i dont think it's worth it. but if it's easy it'd be nice to really highlight the tab in question

docs/content/concepts/webserver/ui.mdx Show resolved Hide resolved
docs/content/concepts/webserver/ui.mdx Outdated Show resolved Hide resolved

Click a schedule to view details about the schedule, including its recent tick history and recent runs.
- **Accessed by:** Clicking the **Overview** tab in the [**Job details**](#job-details) page
Copy link
Contributor

Choose a reason for hiding this comment

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

is there a slightly different way we could explain this? when i first read it i thought it was referring to the top nav Overview tab.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What about In the **Job details** page, click the **Overview** tab?

Copy link
Contributor

Choose a reason for hiding this comment

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

yeah i like that

docs/content/concepts/webserver/ui.mdx Show resolved Hide resolved
docs/content/concepts/webserver/ui.mdx Outdated Show resolved Hide resolved
docs/content/concepts/webserver/ui.mdx Show resolved Hide resolved
docs/content/concepts/webserver/ui.mdx Show resolved Hide resolved
base_url: https://demo.elementl.show
route: /instance/assets
vetted: false
# - id: all-assets.png
Copy link
Contributor

Choose a reason for hiding this comment

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

remove commented entry before merge

@erinkcochran87
Copy link
Contributor Author

Back to you @jamiedemaria!

I think getting Josh's feedback would be good

Asked him about this earlier! He's happy with these changes and didn't have any additions at this time.

I don't think the page is lacking because it doesn't talk about the side nav, but it could be worth mentioning.

I think doing this in a follow-up PR would be good - I want to make sure this gets out in time for launch week, and there's still a lot to get through 😅

how time consuming would it be to put boxes around the "how to get there" buttons in the screenshots to make them jump out even more?

Right now this would be all manually done and would have to be re-done every time we update the screenshots. -_-; I get what you mean though.

Copy link
Contributor

@yuhan yuhan left a comment

Choose a reason for hiding this comment

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

this is so beautiful

Copy link
Contributor

@jamiedemaria jamiedemaria left a comment

Choose a reason for hiding this comment

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

super happy with this page - it does i really good job showing off how nice the UI i!

@erinkcochran87
Copy link
Contributor Author

Thanks for your help on this monster PR, y'all! Off it goes 🚀

@erinkcochran87 erinkcochran87 merged commit 8ff9797 into master Sep 21, 2023
1 check passed
@erinkcochran87 erinkcochran87 deleted the erin/essentials-dagster-ui branch September 21, 2023 15:16
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants