[Docs] Streaming Decks (#6251)

* [Docs] Streaming Decks Signed-off-by: Future-Outlier <[email protected]> * use gitsha and rename video name Signed-off-by: Future-Outlier <[email protected]> --------- Signed-off-by: Future-Outlier <[email protected]>
flyteorg · Feb 18, 2025 · 91a0fd0 · 91a0fd0
1 parent ee919f8
commit 91a0fd0
Showing 1 changed file with 32 additions and 0 deletions.
diff --git a/docs/user_guide/development_lifecycle/decks.md b/docs/user_guide/development_lifecycle/decks.md
@@ -194,3 +194,35 @@ if your deck renderers can enhance data visibility.
 Feel encouraged to open a pull request and play a part in enhancing the Flyte deck renderer ecosystem!
 
 [flytesnacks]: https://github.com/flyteorg/flytesnacks/tree/master/examples/development_lifecycle/
+
+## Streaming Decks
+
+Now you can visualize your deck directly if you call `Deck.publish()` in your code.
+
+```python
+from flytekit.deck import Deck
+
+@task(enable_deck=True)
+def t_deck():
+    Deck.publish()
+```
+
+You can click the refresh button and see the update until the deck succeeds.
+
+```{eval-rst}
+.. raw:: html
+
+   <video width="800" height="450" controls>
+       <source src="https://raw.githubusercontent.com/flyteorg/static-resources/2f3c3c26e9c0168c350bb8cb1bef1ece36ee60ee/flyte/user_guide/development_lifecycle/decks/deck_succeed.mp4">
+   </video>
+```
+
+When the task fails, you can also see the deck in the flyte console.
+
+```{eval-rst}
+.. raw:: html
+
+   <video width="800" height="450" controls>
+       <source src="https://raw.githubusercontent.com/flyteorg/static-resources/2f3c3c26e9c0168c350bb8cb1bef1ece36ee60ee/flyte/user_guide/development_lifecycle/decks/deck_fail.mp4">
+   </video>
+```