Enhancement: Artifacts documentation #13724
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
dylanbhughes
changed the title
…rtifacts-documentation
discdiver
reviewed
May 31, 2024
Co-authored-by: Jeff Hale <discdiver@users.noreply.github.com>
Co-authored-by: Jeff Hale <discdiver@users.noreply.github.com>
Co-authored-by: Jeff Hale <discdiver@users.noreply.github.com>
Co-authored-by: Jeff Hale <discdiver@users.noreply.github.com>
Co-authored-by: Bill Palombi <bill@prefect.io>
Co-authored-by: Bill Palombi <bill@prefect.io>
Co-authored-by: Bill Palombi <bill@prefect.io>
Co-authored-by: Bill Palombi <bill@prefect.io>
Co-authored-by: Bill Palombi <bill@prefect.io>
Co-authored-by: Bill Palombi <bill@prefect.io>
billpalombi
reviewed
May 31, 2024
|
Based on @WillRaphaelson 's comment elsewhere, I would mention that progress artifacts are a Cloud feature. Apologies if I missed that somewhere. |
@discdiver that was a joke -- progress artifacts are in OSS |
|
lol. Just saw it after the fact and thought it was strange. |
Co-authored-by: Bill Palombi <bill@prefect.io>
Co-authored-by: Bill Palombi <bill@prefect.io>
Co-authored-by: Bill Palombi <bill@prefect.io>
billpalombi
approved these changes
May 31, 2024
| @@ -3,32 +3,30 @@ title: Artifacts | |||
| description: Prefect artifacts are persisted outputs designed for human consumption and available in the UI. | |||
| --- | |||
|
|
|||
| Artifacts are persisted outputs such as tables, Markdown, or links. | |||
| Artifacts are rich annotations on Prefect runs. | |||
There was a problem hiding this comment.
Suggested change
| Artifacts are rich annotations on Prefect runs. | |
| Artifacts are annotations on flow and task runs. |
| @@ -3,32 +3,30 @@ title: Artifacts | |||
| description: Prefect artifacts are persisted outputs designed for human consumption and available in the UI. | |||
| --- | |||
|
|
|||
| Artifacts are persisted outputs such as tables, Markdown, or links. | |||
| Artifacts are rich annotations on Prefect runs. | |||
| They are visual metadata intended to be produced in flow or task runs but consumed by humans. | |||
There was a problem hiding this comment.
Suggested change
| They are visual metadata intended to be produced in flow or task runs but consumed by humans. | |
| They are visual metadata intended to be produced in code but consumed by humans. |
| Whether you're publishing links, Markdown, or tables, artifacts provide a powerful and flexible way to showcase data within your workflows. | ||
|
|
||
| With artifacts, you can easily manage and share information with your team, providing valuable insights and context. | ||
| Artifacts are associated with a task run or a flow run. |
There was a problem hiding this comment.
Suggested change
| Artifacts are associated with a task run or a flow run. |
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.
This PR updates the documentation for Artifacts with our new artifact types.
Checklist
<link to issue>"maintenance,fix,feature,enhancement,docs.For documentation changes:
mint.jsonfor files that are removed or renamed.For new functions or classes in the Python SDK:
docs/mint.jsonnavigation.