How to add description for workflow? [Docs]

[y8gao]

Description

I checked the webpages in docs, but not found any document that describes how to add description of workflow in FlyteUI. And in Flyte UI, Description section always says "this workflow has no description".

So my question is: how to add this description or where can I find the related contents?

Are you sure this issue hasn't been raised already?

• [X] Yes

Have you read the Code of Conduct?

• [X] Yes

[welcome[bot]]

Thank you for opening your first issue here! 🛠

[pingsutw]

You could update the description by using flytectl.

flytectl update workflow-meta -p flytesnacks -d development example_test.wf --description "Mergesort workflow example"

[wild-endeavor]

You shouldn't have to use flytectl though... there's ongoing work to bring in user comments. In the hopefully near future, the registration process will just pick up comments from the code for tasks, workflows, and input parameters (and output parameters? @pingsutw )

[wild-endeavor]

Adding pingsutw to this ticket, he's working on it next week. we'll post updates here when we have them. thank

[y8gao]

Good to know this updates. Thanks, and I will try this new version after it is ready. Thanks for your comments.

[eapolinario]

This has been implemented in flytekit 1.3.0.