[docs] Add source control code references docs #22319
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Jun 6, 2024
This stack of pull requests is managed by Graphite. Learn more about stacking. Join @benpankow and the rest of your teammates on |
|
Deploy preview for dagster-docs ready! Preview available at https://dagster-docs-1ejx9w2bl-elementl.vercel.app Direct link to changed pages: |
benpankow
force-pushed
the
benpankow/guide-code-references-dbt
branch
from
305e92c to
918f3c4
Compare
benpankow
force-pushed
the
benpankow/code-references-git
branch
from
9e225d2 to
7f93139
Compare
benpankow
force-pushed
the
benpankow/code-references-git
branch
from
7f93139 to
cebed80
Compare
benpankow
force-pushed
the
benpankow/guide-code-references-dbt
branch
from
875b084 to
ac47dcd
Compare
benpankow
force-pushed
the
benpankow/code-references-git
branch
2 times, most recently
from
3a9a88a to
29b779b
Compare
benpankow
force-pushed
the
benpankow/guide-code-references-dbt
branch
from
f4e6d8e to
6ce81f3
Compare
benpankow
force-pushed
the
benpankow/code-references-git
branch
from
29b779b to
e9156bb
Compare
benpankow
force-pushed
the
benpankow/guide-code-references-dbt
branch
from
6ce81f3 to
0cac947
Compare
benpankow
force-pushed
the
benpankow/code-references-git
branch
from
e9156bb to
12f6271
Compare
benpankow
force-pushed
the
benpankow/guide-code-references-dbt
branch
from
0cac947 to
acff923
Compare
benpankow
force-pushed
the
benpankow/code-references-git
branch
from
12f6271 to
89eb430
Compare
benpankow
force-pushed
the
benpankow/guide-code-references-dbt
branch
from
acff923 to
2f34c5b
Compare
benpankow
force-pushed
the
benpankow/code-references-git
branch
2 times, most recently
from
021df7a to
080127d
Compare
benpankow
force-pushed
the
benpankow/guide-code-references-dbt
branch
2 times, most recently
from
ae49538 to
87722d6
Compare
benpankow
force-pushed
the
benpankow/code-references-git
branch
3 times, most recently
from
eb645c2 to
b774d69
Compare
benpankow
force-pushed
the
benpankow/code-references-git
branch
from
b774d69 to
348d2c2
Compare
sryza
suggested changes
Jul 9, 2024
|
|
||
| ### In Dagster Plus | ||
|
|
||
| If using Dagster Plus, you can use the `link_code_references_to_git_if_cloud` utility to conditionally convert local file code references to source control links. This utility will automatically detect if your code is running in a Dagster Cloud environment and convert local file code references to source control links, pointing at the commit hash of the code running in the current deployment. |
There was a problem hiding this comment.
Can we use PyObject to link to the API doc?
There was a problem hiding this comment.
As below - cloud packages aren't worked into the docs build
|
|
||
| If using Dagster Plus, you can use the `link_code_references_to_git_if_cloud` utility to conditionally convert local file code references to source control links. This utility will automatically detect if your code is running in a Dagster Cloud environment and convert local file code references to source control links, pointing at the commit hash of the code running in the current deployment. | ||
|
|
||
| ```python |
There was a problem hiding this comment.
This snippet should go in a .py file.
There was a problem hiding this comment.
Right now our docs build doesn't include cloud packages, so this won't work in a snippet file. Can file as a todo?
There was a problem hiding this comment.
Ah yeah - worth adding a comment to explain why we're doing this.
Co-authored-by: Sandy Ryza <[email protected]>
sryza
reviewed
Jul 9, 2024
..._snippets/docs_snippets/guides/dagster/code_references/link_to_source_control_conditional.py
Outdated
Show resolved
Hide resolved
| @@ -27,7 +27,7 @@ To complete the steps in this guide, you'll need: | |||
|
|
|||
| --- | |||
|
|
|||
| ## Automatically attaching code references to asset definitions | |||
| ## Automatically attaching local file code references to asset definitions | |||
|
|
|||
| ### Assets defined in Python | |||
|
|
|||
There was a problem hiding this comment.
I can't comment on the line below, but we should use PyObject and avoid an import that goes through a private path.
sryza
approved these changes
Jul 9, 2024
benpankow
force-pushed
the
benpankow/code-references-git
branch
from
5c16d82 to
9615f76
Compare
benpankow
added a commit
that referenced
this pull request
Jul 9, 2024
## Summary Expands the code references guide to include info on attaching references to git source control on cloud and OSS. ## Test Plan Vercel. --------- Co-authored-by: Sandy Ryza <[email protected]>
PedramNavid
reviewed
Jul 16, 2024
|
|
||
| ### Assets defined in Python | ||
|
|
||
| To automatically attach code references to Python assets' function definitions, you can use the `dagster._core.definitions.metadata.with_source_code_references` utility. Any asset definitions passed to the utility will have their source file attached as metadata. | ||
| To automatically attach code references to Python assets' function definitions, you can use the <PyObject module="dagster" object="with_source_code_references"/> utility. Any asset definitions passed to the utility will have their source file attached as metadata. |
There was a problem hiding this comment.
This PyObject link doesn't work
| @@ -65,7 +65,7 @@ Dagster's dbt integration can automatically attach references to the SQL files b | |||
|
|
|||
There was a problem hiding this comment.
A link to the asset's source in `with_source_code_references.py` will then be visible in the **Asset Catalog** view in the Dagster UI:
There's no reference to with_source_code_references.py in the above prose/code.
There was a problem hiding this comment.
Also that image is way too big
|
|
||
| ### In any Dagster environment | ||
|
|
||
| The <PyObject module="dagster" object="link_code_references_to_git"/> utility allows you to convert local file code references to source control links. You'll need to provide the base URL of your git repository, the branch or commit hash, and a path to the repository root locally. |
There was a problem hiding this comment.
This PyObject also doesn't work
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Expands the code references guide to include info on attaching references to git source control on cloud and OSS.
Test Plan
Vercel.