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

Offer a more compact presentation of the service launch configuration form #932

Open
Gaspi opened this issue Feb 10, 2025 · 1 comment
Open

Comments

@Gaspi
Copy link

Gaspi commented Feb 10, 2025

As shown in the example below, a couple of small things slightly hinder the user experience when configuring a service before launch:

  1. The title and description fields from the values schema files are meant for documentation and not user interface definition. As such, they are often defined in a more verbose or redundant way than is preferable in our context.
  2. The configuration structure is naturally inherited from the values.yaml which is sometimes a bit too deeply hierarchical whereas forms are usually more linear. The Custom box, below, for example, doesn’t add much value to the interface.
  3. The vertical margins: it's nice to have a well-spaced interface, but with the various top banners, it forces a lot of scrolling and prevents getting a quick overall view of the form.

Image

My suggestions (up for discussion):

  1. The title and description fields may be defined in Onyxia catalogs to better fit the needs of a user interface. However the resulting values.schema.json file would then be hard to read or reuse in a different setting. Instead it could be useful to provide alternatives for these (rightfully) descriptive fields. For instance:
  {
    "title": "A precise field title",
    "description": "An exhaustive description",
    "x-onyxia": {
      "title": "Short title",
      "description": "Extra info in subtitle or empty string to hide"
    }
  }
  1. Move the longer description into a tooltip (a small icon that would display the text either on click or hover in a mini-popup) rather than a smaller font subtitle. Short description could be kept inline, as they are now. The display mode could also be controlled in values.schema.json:
  "x-onyxia": {
    "descriptionStyle": "tooltip/inline"
  }
  1. Allow some hierarchical boxes to be hidden, with their content "overflowing" into the containing box. Again, this should probably also be controlled:
{
  "x-onyxia": {
    "showBox": false
  },
  "render": "none or dissolved"
}
  1. Reduce vertical margins.

Below a suggestion of a target interface that, in my opinion, would be more usable while remaining precise enough for new users.

Image

@dylangovender
Copy link

Love suggestion #3 (custom image option being inline with the pull policy option).

After using V10 for a few weeks now, I think it would make the UX better.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants