Workflow input ordering and description

[ajsalow]

Motivation: Why do you think this is important? The current UI for workflow input would be more user friendly if workflow inputs had additional descriptions other than their name. Additionally, inputs are sorted alphabetically but user might want arrange inputs in a specific order.

Goal: What should the final outcome look like, ideally? Don't sort inputs, keep in order that user defines in workflow. Parse doc string of workflow for input description and include in UI if found.

Describe alternatives you've considered

[Optional] Propose: Link/Inline OR Additional context If you have ideas about the implementation please propose the change. If inline keep it short, if larger then you link to an external document.

[kumare3]

@ajsalow Absolutely agree with the docs. We had the functionality of showing the description in the legacy API of flytekit. But we will work on this soon. We have an entire story about documentation. Would you be open to contributing?

@wild-endeavor we discussed this -

[EngHabu]

From Gleb: https://developers.google.com/protocol-buffers/docs/proto3#backwards_compatibility

It's possible that we can convert a map to a list in protobuf and keep the wire-format the same

[kumare3]

We should get the description part done in v0.15.0

[EngHabu]

@katrogan, @wild-endeavor is this going to happen as part of Code Doc revamp work? is there a quicker win here for descriptions?

[wild-endeavor]

This will happen as part of the code documentation project yeah, but this part is relatively easy and we should add it and release it as soon as possible. I don't think it'll happen by the 0.15.0 release though since that's eod or eot.

[pingsutw]

Reopen it. we've reverted the PR. Instead of changing the map to list, we can add an index field here to keep original order.

[github-actions[bot]]

Hello 👋, this issue has been inactive for over 9 months. To help maintain a clean and focused backlog, we'll be marking this issue as stale and will engage on it to decide if it is still applicable. Thank you for your contribution and understanding! 🙏

[jdanbrown]

Bumping this issue because it's gone stale. It's very confusing UX that the workflow inputs in the flyte web UI aren't sorted in the same order that they're declared in the python @workflow function. Alphabetical ordering is surprising to the user because it destroys the conceptual order the encoded in their function definition, and below is an example where it's even a bit error prone because it swaps train/test to test/train:

@workflow
def wf(
    train_window: str,
    test_window: str,
):
    ...

Launch Workflow:

[github-actions[bot]]

Hello 👋, this issue has been inactive for over 9 months. To help maintain a clean and focused backlog, we'll be marking this issue as stale and will engage on it to decide if it is still applicable. Thank you for your contribution and understanding! 🙏

[dwo]

👋 Commenting to un-stale, this is still relevant.