Readme update 2023 #4549
Readme update 2023 #4549
Conversation
Signed-off-by: davidmirror-ops <[email protected]>
Signed-off-by: davidmirror-ops <[email protected]>
Signed-off-by: davidmirror-ops <[email protected]>
Signed-off-by: davidmirror-ops <[email protected]>
Signed-off-by: davidmirror-ops <[email protected]>
dosubot
bot
added
the
size:L
Signed-off-by: David Espejo <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4549 +/- ##
=======================================
Coverage 58.11% 58.12%
=======================================
Files 626 626
Lines 53815 53815
=======================================
+ Hits 31277 31278 +1
+ Misses 20036 20035 -1
Partials 2502 2502
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
README.md
Outdated
| Write code in Python or any other language and leverage a robust type engine. | ||
| </p> | ||
|
|
||
| <img alt="Getting started with Flyte" src="https://raw.githubusercontent.com/flyteorg/static-resources/main/common/flytereadmebuildv2.gif" style="width: 100%; height: auto;" /> |
There was a problem hiding this comment.
can we reduce the size of the GIF window?
There was a problem hiding this comment.
also, i'm not sure if this is a big ask, but could we consider including a different example here? :)
this would be amazing.
There was a problem hiding this comment.
That's a good example yes, the problem is that the GIF will be a bit longer (more code) and this one doesn't showcase the subworkfows that are probably not the most prominent feature but something a bit beyond the hello world
README.md
Outdated
|
|
||
|
|
||
| ## How to stay involved? | ||
|
|
There was a problem hiding this comment.
can we remove the additional new lines here?
| - [Forecast sales with Horovod and Spark](https://docs.flyte.org/projects/cookbook/en/latest/auto_examples/forecasting_sales/index.html) | ||
| - [Nucleotide Sequence Querying with BLASTX](https://docs.flyte.org/projects/cookbook/en/latest/auto_examples/blast/index.html) |
There was a problem hiding this comment.
haven't tested these examples recently. but i think that's okay.
README.md
Outdated
| :arrows_counterclockwise: **Parallelism**: Flyte tasks are inherently parallel to optimize resource consumption and improve performance. <br /> | ||
| :floppy_disk: **Allocate resources dynamically** at the task level. <br /> | ||
| :play_or_pause_button: [Wait](https://docs.flyte.org/projects/cookbook/en/latest/auto_examples/advanced_composition/waiting_for_external_inputs.html) for **external inputs** before proceeding with the execution. <br /> | ||
| <img alt="Getting started with Flyte, showing the welcome screen and Flyte dashboard" src="https://raw.githubusercontent.com/flyteorg/static-resources/main/flytesnacks/getting_started/getting_started_console.gif" style="width: 100%; height: auto;" /> |
There was a problem hiding this comment.
we should probably place this GIF below pyflyte run --remote hello_world.py hello_world_wf command.
README.md
Outdated
| 💾 **Allocate resources dynamically** at the task level. <br /> | ||
|
|
||
|
|
||
| ## Who's using Flyte? |
There was a problem hiding this comment.
is a question mark in this and the next heading a strict requirement? not having one will maintain consistency.
|
overall, the readme looks great! thanks for working on this, David! |
Signed-off-by: davidmirror-ops <[email protected]>
Signed-off-by: davidmirror-ops <[email protected]>
Signed-off-by: davidmirror-ops <[email protected]>
Signed-off-by: davidmirror-ops <[email protected]>
Why are the changes needed?
Looking to make the README a more educational resource
What changes were proposed in this pull request?
How was this patch tested?
Setup process
Screenshots
Check all the applicable boxes
Related PRs
Docs link