flyte icon indicating copy to clipboard operation
flyte copied to clipboard

[Docs] document file and directory streaming

Open samhita-alla opened this issue 2 years ago • 3 comments

Description

the flytefile and flytedirectory streaming feature is currently experimental. nonetheless, it's important that we document it in the user guide: https://docs.flyte.org/projects/cookbook/en/latest/auto_examples/data_types_and_io/file.html and https://docs.flyte.org/projects/cookbook/en/latest/auto_examples/data_types_and_io/folder.html pages.

streaming PR: https://github.com/flyteorg/flytekit/pull/1512 additional details can be found in the release notes.

Are you sure this issue hasn't been raised already?

  • [X] Yes

Have you read the Code of Conduct?

  • [X] Yes

samhita-alla avatar Nov 20 '23 16:11 samhita-alla

Added to planned work for docs team.

neverett avatar Dec 08 '23 17:12 neverett

@neverett did we end up documenting this?

kumare3 avatar Jul 03 '24 00:07 kumare3

I think I can work on this one~

DenChenn avatar Oct 16 '24 07:10 DenChenn

@davidmirror-ops done ✅

DenChenn avatar Oct 23 '24 05:10 DenChenn

Completed in #5879

davidmirror-ops avatar Oct 23 '24 17:10 davidmirror-ops