kestra icon indicating copy to clipboard operation
kestra copied to clipboard

Prepare a new design of the plugin properties display

Open anna-geller opened this issue 1 year ago • 3 comments

Feature description

  1. The type and default need to remain as is = prominently displayed. In contrast, required and dynamic (or not) can be just an icon
  2. Expand + collapse properties, outputs and metrics with collapsed by default
  3. Expand + collapse for each single property (property description, type and default value) - the icons can be displayed directly
  4. Redesign a "homepage" of each plugin

Example property as of today

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌
  • Default: false

image

anna-geller avatar Jun 27 '24 13:06 anna-geller

Table of content to make it easy to see all available properties etc. Not available in Kestra. Only on the website, e.g: https://kestra.io/plugins/core/tasks/http/io.kestra.plugin.core.http.request Screenshot 2024-06-27 at 14 14 33

wrussell1999 avatar Jun 27 '24 13:06 wrussell1999

Making sure the custom types are obviously clickable and link to their specific section.

Screenshot 2024-06-27 at 14 15 29

wrussell1999 avatar Jun 27 '24 13:06 wrussell1999

image

  • for required properties then ⚙️ for configurable/dynamic

image

anna-geller avatar Jun 27 '24 13:06 anna-geller

Note to self: discuss with Nico when he's back to extend this figma design https://www.figma.com/design/g8Di3M1gbajOjOqp0ZrzXO/02_Kestra.io?node-id=10976-88344&t=XQemhHC3x27UJPE8-1:

  1. Move deprecated properties into a separate section e.g. Python script now has multiple deprecated properties like runner, docker, outputDir - distracting to new users, unpleasant to existing ones
  2. Detailed Table of contents in the right sidebar for all Properties, Examples, Outputs
  3. Allow providing examples for specific properties e.g. in the Python example you use, we could offer 2 full examples of how to use Python task with Docker and AWS Batch task runners, but this example would need to be under the taskRunner property rather than in the main examples -- this was requested by the community https://github.com/kestra-io/kestra/issues/4226
  4. For default values, I'd prefer to show it more prominently, perhaps in a grey color right before the type?
  5. We are missing an example of a clickable definition. in python plugin, NamespaceFiles is a clickable definition, it would be nice to perhaps show it as a hyperlink?

anna-geller avatar Jul 27 '24 10:07 anna-geller

Done here, reopen if I'm mistaken

brian-mulier-p avatar Apr 07 '25 19:04 brian-mulier-p