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

DOC-655 Docs for updated asset selection syntax #27672

Open
wants to merge 43 commits into
base: master
Choose a base branch
from

Conversation

neverett
Copy link
Contributor

@neverett neverett commented Feb 7, 2025

Summary & Motivation

Updates "Asset selection syntax" doc with the new asset selection syntax.

How I Tested These Changes

Local build.

Changelog

Insert changelog entry or delete this section.

@neverett neverett added the area: docs Related to documentation in general label Feb 7, 2025
@neverett neverett self-assigned this Feb 7, 2025
@neverett neverett changed the title start reference doc (to be combined with existing doc) Docs for updated asset selection syntax Feb 7, 2025
…assets docs, link to new asset selection syntax doc

Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
@neverett neverett changed the title Docs for updated asset selection syntax DOC-655 Docs for updated asset selection syntax Feb 10, 2025
Signed-off-by: nikki everett <[email protected]>
@neverett neverett marked this pull request as ready for review February 19, 2025 22:50
Copy link

github-actions bot commented Feb 19, 2025

Deploy preview for dagster-docs ready!

Preview available at https://dagster-docs-c627y0gjc-elementl.vercel.app
https://nikki-docs-updated-asset-selection-syntax.archive.dagster-docs.io

Direct link to changed pages:

Signed-off-by: nikki everett <[email protected]>
@@ -1,610 +0,0 @@

Copy link
Contributor

Choose a reason for hiding this comment

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

deleting this seems unintentional ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This file is rebuilt in production, so doesn't need to be checked in (although checking it in won't cause any harm)

@salazarm
Copy link
Contributor

Hmm, I kind of want the path examples to stand out a bit more, It's lost in the sea of examples and I think when people see it a lightbulb will go off on their head that maybe we should move it to the top?

sidebar_position: 100
---

This page contains common example asset selection queries and their implementation in Python, CLI, and the Dagster UI. For a full explanation of the filters, layers, operands, and functions that you can use to construct your own queries, see "[Asset selection syntax reference](reference)".
Copy link
Contributor

Choose a reason for hiding this comment

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

This is the first page in the dropdown and immediately directs you to the second page, so maybe the reference should go first?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I can put the reference page first -- I put the examples page first in order to make the path examples as prominent as possible, but those should be easier to find now that they're at the top of the page, regardless of the page's position in the sidebar.

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 this better!

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 Related to documentation in general
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants