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

[Plugins markdown redesign] Improve the design of the plugin documentation with expandable/collapsible properties display #4154

Open
anna-geller opened this issue Jun 27, 2024 · 4 comments
Assignees
Labels
area/frontend Needs frontend code changes enhancement New feature or request

Comments

@anna-geller
Copy link
Member

anna-geller commented Jun 27, 2024

Goals

  1. More compact display of properties to avoid overwhelm
  2. Provide full examples related to any given properties directly within that property description rather than at the top (requested by a user here Examples displaying in documentation #4226)

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 anna-geller added the enhancement New feature or request label Jun 27, 2024
@wrussell1999
Copy link
Member

wrussell1999 commented Jun 27, 2024

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
Copy link
Member

wrussell1999 commented Jun 27, 2024

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

Screenshot 2024-06-27 at 14 15 29

@anna-geller
Copy link
Member Author

anna-geller commented Jun 27, 2024

image

  • for required properties
    then ⚙️ for configurable/dynamic

image

@anna-geller
Copy link
Member Author

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 Examples displaying in documentation #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 anna-geller changed the title Prepare a new design of the plugin properties display [Plugins markdown redesign] Improve the design of the plugin documentation with expandable/collapsible properties display Jul 27, 2024
@anna-geller anna-geller added kind/highlight One of the highlights of the upcoming release and removed kind/highlight One of the highlights of the upcoming release labels Aug 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/frontend Needs frontend code changes enhancement New feature or request
Projects
Status: Backlog
Development

No branches or pull requests

4 participants