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(artifacts): notate OSS as streaming capable in v3.6+ #13582

Merged
merged 1 commit into from
Sep 10, 2024

Conversation

Joibel
Copy link
Member

@Joibel Joibel commented Sep 9, 2024

Missing documentation update from #12908.

Just add OSS as streaming capable in v3.6+.

Signed-off-by: Alan Clucas <alan@clucas.org>
@Joibel Joibel marked this pull request as ready for review September 9, 2024 15:39
Copy link
Contributor

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

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

I noticed this was missing recently too, thanks for adding this!

@@ -623,7 +623,7 @@ configuring the default artifact repository described previously.
## Artifact Streaming

With artifact streaming, artifacts don’t need to be saved to disk first. Artifact streaming is only supported in the following
artifact drivers: S3 (v3.4+), Azure Blob (v3.4+), HTTP (v3.5+), and Artifactory (v3.5+).
artifact drivers: S3 (v3.4+), Azure Blob (v3.4+), HTTP (v3.5+), Artifactory (v3.5+), and OSS (v3.6+).
Copy link
Contributor

Choose a reason for hiding this comment

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

we should probably change this to a table given there's 5+ drivers here now

Copy link
Contributor

Choose a reason for hiding this comment

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

Or add "Streaming" to the top level table on this page. Which might be a bit dated too as well

Copy link
Member Author

Choose a reason for hiding this comment

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

This whole page probably wants some effort putting in. This was a minimum update just for correctness.

Copy link
Contributor

@agilgur5 agilgur5 Sep 9, 2024

Choose a reason for hiding this comment

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

Oh for sure, I've been gradually reviewing large pieces of it in PRs (#13376 and #12467 (review)).
Also the general page on using artifacts (vs configuring the artifact repo) is one of the docs pages that needs the most work 😅 (I actually have changes to it dating back probably 10+ months ago, but kept finding more and more things to fix 🫠 )

This was a minimum update just for correctness.

I did approve the PR as well, i.e. making this comment optional

@agilgur5 agilgur5 added area/docs Incorrect, missing, or mistakes in docs area/artifacts S3/GCP/OSS/Git/HDFS etc labels Sep 9, 2024
@agilgur5 agilgur5 added this to the v3.6.0 milestone Sep 9, 2024
@agilgur5 agilgur5 changed the title docs: add OSS streaming for v3.6 docs(artifacts): notate OSS as streaming capable in v3.6+ Sep 9, 2024
@Joibel Joibel merged commit 88ebcdb into main Sep 10, 2024
16 checks passed
@Joibel Joibel deleted the oss-streaming-doc branch September 10, 2024 09:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/artifacts S3/GCP/OSS/Git/HDFS etc area/docs Incorrect, missing, or mistakes in docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants