Add screenshots of Flyte UI in the docstring workflow page (#1049)

* Add screenshots of Flyte UI in the docstring workflow page Signed-off-by: Kevin Su <[email protected]> * update link Signed-off-by: Kevin Su <[email protected]> * lint Signed-off-by: Kevin Su <[email protected]> --------- Signed-off-by: Kevin Su <[email protected]>
flyteorg · Aug 25, 2023 · 3ebf229 · 3ebf229
1 parent 20a7f1f
commit 3ebf229
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/examples/basics/basics/documented_workflow.py b/examples/basics/basics/documented_workflow.py
@@ -64,6 +64,19 @@ def sphinx_docstring(df: pd.DataFrame, data: PandasData = PandasData()) -> pd.Da
     return add_data(df=df, data=data)
 
 
+# %% [markdown]
+# You'll see the short description in the workflow page.
+# :::{figure} https://github.com/flyteorg/static-resources/blob/main/flyte/concepts/basics/short_description.png
+# :alt: short description
+# :class: with-shadow
+# :::
+#
+# If you click the workflow, you'll see the long description in the basic information section.
+# :::{figure} https://github.com/flyteorg/static-resources/blob/main/flyte/concepts/basics/long_description.png
+# :alt: short description
+# :class: with-shadow
+# :::
+
 # %% [markdown]
 # ## NumPy-style Docstring
 #