-
Notifications
You must be signed in to change notification settings - Fork 652
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
[Feature][Flytekit] Task and Workflow docstrings should be converted to descriptions #434
Comments
Today the TaskSpec, WorkflowSpec & LaunchPlanSpec do not have Descriptions. message Description {
string description;
string content_type; // legal mimetype like text/string, html etc
}; The idea is that we should allow these descriptions to automatically become a documentation. One thing I found is we can use NamedEntity, but its not clear when to use this - @katrogan |
@kumare3 Can you give me more detail about the issue, Apart from adding |
@evalsocket I am actually in favor of closing this issue in favor of - #531 |
Signed-off-by: Haytham Abuelfutuh <haytham@afutuh.com>
…gs (flyteorg#434) * resurrected fold-logs.py script Signed-off-by: Daniel Rammer <daniel@union.ai> * printing more info Signed-off-by: Daniel Rammer <daniel@union.ai> * formatting output Signed-off-by: Daniel Rammer <daniel@union.ai> * removed queue tracking Signed-off-by: Daniel Rammer <daniel@union.ai> * added cache logs Signed-off-by: Daniel Rammer <daniel@union.ai> * cleaning up block definitions for uniformity Signed-off-by: Daniel Rammer <daniel@union.ai> * added comments Signed-off-by: Daniel Rammer <daniel@union.ai> * added argparse Signed-off-by: Daniel Rammer <daniel@union.ai> * tracking workflow enqueues on node updates Signed-off-by: Daniel Rammer <daniel@union.ai> * moved fold-logs.py to a script directory Signed-off-by: Daniel Rammer <daniel@union.ai> * parse gcp formatted logs (flyteorg#435) Co-authored-by: Babis Kiosidis <babisk@spotify.com> Signed-off-by: Daniel Rammer <daniel@union.ai> Co-authored-by: Babis Kiosidis <ckiosidis@gmail.com> Co-authored-by: Babis Kiosidis <babisk@spotify.com>
* Update docs on secrets Signed-off-by: Fredrik Sannholm <fredrik.sannholm@wolt.com> * Typo Signed-off-by: Fredrik Sannholm <fredrik.sannholm@wolt.com> * rewording Signed-off-by: Fredrik Sannholm <fredrik.sannholm@wolt.com>
* ci: move storybook related packages to top level * ci: ensure that lint can be run in PR checks * ci: allow to run tests linux setup Signed-off-by: Nastya Rusina <nastya@union.ai>
…gs (flyteorg#434) * resurrected fold-logs.py script Signed-off-by: Daniel Rammer <daniel@union.ai> * printing more info Signed-off-by: Daniel Rammer <daniel@union.ai> * formatting output Signed-off-by: Daniel Rammer <daniel@union.ai> * removed queue tracking Signed-off-by: Daniel Rammer <daniel@union.ai> * added cache logs Signed-off-by: Daniel Rammer <daniel@union.ai> * cleaning up block definitions for uniformity Signed-off-by: Daniel Rammer <daniel@union.ai> * added comments Signed-off-by: Daniel Rammer <daniel@union.ai> * added argparse Signed-off-by: Daniel Rammer <daniel@union.ai> * tracking workflow enqueues on node updates Signed-off-by: Daniel Rammer <daniel@union.ai> * moved fold-logs.py to a script directory Signed-off-by: Daniel Rammer <daniel@union.ai> * parse gcp formatted logs (flyteorg#435) Co-authored-by: Babis Kiosidis <babisk@spotify.com> Signed-off-by: Daniel Rammer <daniel@union.ai> Co-authored-by: Babis Kiosidis <ckiosidis@gmail.com> Co-authored-by: Babis Kiosidis <babisk@spotify.com>
Signed-off-by: Haytham Abuelfutuh <haytham@afutuh.com>
Motivation: Why do you think this is important?
Python way of adding descriptions is using docstrings. Today this is not very well integrated into flytekit
Goal: What should the final outcome look like, ideally?
The description of a task or a Workflow should be the comment in the body of the task/workflow by default. This should then be visible in the UI.
Describe alternatives you've considered
NA
Flyte component
[Optional] Propose: Link/Inline
NA
Additional context
NA
Is this a blocker for you to adopt Flyte
NA
The text was updated successfully, but these errors were encountered: