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

Display "how to install" button on tasks table #674

Closed
tcompa opened this issue Dec 11, 2024 · 4 comments · Fixed by #677
Closed

Display "how to install" button on tasks table #674

tcompa opened this issue Dec 11, 2024 · 4 comments · Fixed by #677

Comments

@tcompa
Copy link
Collaborator

tcompa commented Dec 11, 2024

Ref

The task objects may include an additional (optional) property called install_instructions, with a value which is a markdown-formatted block of text.

If the install_instructions field is present, we should display a new button next to the "info" button. An option would be to have it look like a "+" (as in "How to add this task").

When clicked, this button should open a modal which displays the mardown-formatted install_instructions value.

This feature is needed for the public-page tasks list only, which means we would be introducing a slightly incorrect type for task objects (as we would be adding an optional property which will never be present when the task is generated by the backend). I'd say it's acceptable, but we can review this if relevant.

Side note

If it is useful, we could define a new config variable for the tasks-list component (e.g. "display_type"), with values "fractal-web-modal", "fractal-web-single-page", "public-page". This config would determine what is included when.

If we can avoid it, all the better.

In this specific case, it is not strictly needed - since the install_instructions property would never be present in the API-provided JSON.

@tcompa
Copy link
Collaborator Author

tcompa commented Dec 11, 2024

image
image

cc @jluethi does this look reasonable?

@jluethi
Copy link
Collaborator

jluethi commented Dec 11, 2024

This is a great start! :)

Can we use a slightly smaller header (for Fractal installation & Python installation)? Given that it's a long title & it's sometimes longer than the text below, having it a bit smaller would probably look better

@tcompa
Copy link
Collaborator Author

tcompa commented Dec 11, 2024

Can we use a slightly smaller header

Sure.

Here are some updated examples:
image
image
image
image

@jluethi
Copy link
Collaborator

jluethi commented Dec 11, 2024

That's great!

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

Successfully merging a pull request may close this issue.

2 participants