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

Extract task-list page into separate component, to be re-used in public task-list landing page #666

Closed
tcompa opened this issue Dec 3, 2024 · 1 comment · Fixed by #671

Comments

@tcompa
Copy link
Collaborator

tcompa commented Dec 3, 2024

(ref fractal-analytics-platform/fractal-tasks-core#871)

The current version https://tcompa.github.io/test-table-github-page example is based on https://datatables.net. We could customize it at will, but this kind of work would be very similar to the new task-list page (ref #654 (comment)).

With @zonia3000 we are planning to proceed the same way as we did when we isolated a jschema component and re-used it for the static sandbox pages in the docs. In this case it would be e.g. a tasks_table component, which would be used (with different data) in a public task-list landing page.

Remarks:

  1. This approach will be much simpler than re-implementing the same table twice (once for fractal-web and once for the public page), which clearly matters if we move to more complex information.
  2. With this approach, we are assuming that we will only have a single format for underlying table data, namely the format of the API response. The data-retrieval procedure for the public page will always have to align with this format.
  3. Any update of the table visualization will apply both to the web client and to the task-list public page (as soon as they are updated to the same version). The advantage is that we need to design changes only once, while the disadvantage is that we may have a bit of friction if we have very specific requirements for the public landing page which are not relevant for the Fractal instance. My first guess is that the disadvantage will not matter for a while.
  4. The current decisions does not affect the question about where/how we will display this table in the docs. At first, it can be a standalone page (the same as the current sandbox pages). Later we can decide whether it needs to be integrated e.g. as part of https://fractal-analytics-platform.github.io.

cc @jluethi - does this sound reasonable?
If so, we'll proceed as in:

  • In fractal-web, create the new independent component
  • We move from my own testing repo to a Fractal repo - could it be fractal-task-list and https://fractal-analytics-platform.github.io/fractal-task-list?
  • We setup the two parts of this new repo: data retrieval that matches with the fractal-server API, and static page building based on the new fractal-web component.

Out of scope: web components (ref #512)

@jluethi
Copy link
Collaborator

jluethi commented Dec 3, 2024

This sounds like a great plan!

Later we can decide whether it needs to be integrated e.g. as part of https://fractal-analytics-platform.github.io/.

From my side, we can also directly start as this instead of setting up a separate task list repo? Getting it on the splash page would be the core goal I'd say!

@tcompa tcompa transferred this issue from fractal-analytics-platform/fractal-web Dec 3, 2024
@tcompa tcompa transferred this issue from fractal-analytics-platform/fractal-analytics-platform.github.io Dec 3, 2024
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