Skip to content
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

Closed
1 of 13 tasks
kumare3 opened this issue Jul 30, 2020 · 3 comments
Closed
1 of 13 tasks
Assignees
Labels
enhancement New feature or request flytekit FlyteKit Python related issue good first issue Good for newcomers untriaged This issues has not yet been looked at by the Maintainers

Comments

@kumare3
Copy link
Contributor

kumare3 commented Jul 30, 2020

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

  • Overall
  • Flyte Setup and Installation scripts
  • Flyte Documentation
  • Flyte communication (slack/email etc)
  • FlytePropeller
  • FlyteIDL (Flyte specification language)
  • Flytekit (Python SDK)
  • FlyteAdmin (Control Plane service)
  • FlytePlugins
  • DataCatalog
  • FlyteStdlib (common libraries)
  • FlyteConsole (UI)
  • Other

[Optional] Propose: Link/Inline
NA

Additional context
NA

Is this a blocker for you to adopt Flyte
NA

@kumare3 kumare3 added enhancement New feature or request untriaged This issues has not yet been looked at by the Maintainers labels Jul 30, 2020
@kumare3 kumare3 added this to the 0.8.0 milestone Jul 30, 2020
@kumare3 kumare3 added good first issue Good for newcomers help wanted Extra attention is needed labels Aug 5, 2020
@kumare3 kumare3 removed their assignment Sep 28, 2020
@kumare3 kumare3 modified the milestones: 0.8.0, 0.10.0 Sep 28, 2020
@kumare3
Copy link
Contributor Author

kumare3 commented Sep 28, 2020

Today the TaskSpec, WorkflowSpec & LaunchPlanSpec do not have Descriptions.
My preference is that we have 2 parts for a Description and we create a new message called

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

@EngHabu EngHabu removed this from the 0.10.0 milestone Jan 11, 2021
@kumare3 kumare3 added flytekit FlyteKit Python related issue and removed help wanted Extra attention is needed labels Feb 9, 2021
@yindia yindia self-assigned this Feb 15, 2021
@yindia
Copy link
Contributor

yindia commented Feb 21, 2021

@kumare3 Can you give me more detail about the issue, Apart from adding Description in proto

@kumare3
Copy link
Contributor Author

kumare3 commented Feb 21, 2021

@evalsocket I am actually in favor of closing this issue in favor of - #531

@yindia yindia closed this as completed Feb 22, 2021
eapolinario pushed a commit to eapolinario/flyte that referenced this issue Dec 6, 2022
eapolinario pushed a commit to eapolinario/flyte that referenced this issue Dec 6, 2022
…gs (flyteorg#434)

* resurrected fold-logs.py script

Signed-off-by: Daniel Rammer <[email protected]>

* printing more info

Signed-off-by: Daniel Rammer <[email protected]>

* formatting output

Signed-off-by: Daniel Rammer <[email protected]>

* removed queue tracking

Signed-off-by: Daniel Rammer <[email protected]>

* added cache logs

Signed-off-by: Daniel Rammer <[email protected]>

* cleaning up block definitions for uniformity

Signed-off-by: Daniel Rammer <[email protected]>

* added comments

Signed-off-by: Daniel Rammer <[email protected]>

* added argparse

Signed-off-by: Daniel Rammer <[email protected]>

* tracking workflow enqueues on node updates

Signed-off-by: Daniel Rammer <[email protected]>

* moved fold-logs.py to a script directory

Signed-off-by: Daniel Rammer <[email protected]>

* parse gcp formatted logs (flyteorg#435)

Co-authored-by: Babis Kiosidis <[email protected]>
Signed-off-by: Daniel Rammer <[email protected]>

Co-authored-by: Babis Kiosidis <[email protected]>
Co-authored-by: Babis Kiosidis <[email protected]>
eapolinario pushed a commit to eapolinario/flyte that referenced this issue Dec 20, 2022
* Update docs on secrets

Signed-off-by: Fredrik Sannholm <[email protected]>

* Typo

Signed-off-by: Fredrik Sannholm <[email protected]>

* rewording

Signed-off-by: Fredrik Sannholm <[email protected]>
eapolinario pushed a commit to eapolinario/flyte that referenced this issue Dec 20, 2022
* 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 <[email protected]>
eapolinario pushed a commit to eapolinario/flyte that referenced this issue Aug 9, 2023
…gs (flyteorg#434)

* resurrected fold-logs.py script

Signed-off-by: Daniel Rammer <[email protected]>

* printing more info

Signed-off-by: Daniel Rammer <[email protected]>

* formatting output

Signed-off-by: Daniel Rammer <[email protected]>

* removed queue tracking

Signed-off-by: Daniel Rammer <[email protected]>

* added cache logs

Signed-off-by: Daniel Rammer <[email protected]>

* cleaning up block definitions for uniformity

Signed-off-by: Daniel Rammer <[email protected]>

* added comments

Signed-off-by: Daniel Rammer <[email protected]>

* added argparse

Signed-off-by: Daniel Rammer <[email protected]>

* tracking workflow enqueues on node updates

Signed-off-by: Daniel Rammer <[email protected]>

* moved fold-logs.py to a script directory

Signed-off-by: Daniel Rammer <[email protected]>

* parse gcp formatted logs (flyteorg#435)

Co-authored-by: Babis Kiosidis <[email protected]>
Signed-off-by: Daniel Rammer <[email protected]>

Co-authored-by: Babis Kiosidis <[email protected]>
Co-authored-by: Babis Kiosidis <[email protected]>
eapolinario pushed a commit to eapolinario/flyte that referenced this issue Aug 21, 2023
eapolinario pushed a commit to eapolinario/flyte that referenced this issue Apr 30, 2024
eapolinario pushed a commit to eapolinario/flyte that referenced this issue Apr 30, 2024
austin362667 pushed a commit to austin362667/flyte that referenced this issue May 7, 2024
robert-ulbrich-mercedes-benz pushed a commit to robert-ulbrich-mercedes-benz/flyte that referenced this issue Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request flytekit FlyteKit Python related issue good first issue Good for newcomers untriaged This issues has not yet been looked at by the Maintainers
Projects
None yet
Development

No branches or pull requests

3 participants