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

[FEATURE] Add micro service for template registry #158

Open
Freymaurer opened this issue Jul 3, 2024 · 8 comments
Open

[FEATURE] Add micro service for template registry #158

Freymaurer opened this issue Jul 3, 2024 · 8 comments
Assignees

Comments

@Freymaurer
Copy link
Collaborator

With the current activity on this repository it might be nice to improve the current template infrastructure. @kMutagene set up a small database with ui to registrate validation packages for ARCs. A technology we could reuse for a template registry.

In my opinion this would be a improvement, as it would improve search performance and granularity, as well as add true versioning, instead of the "please increase the version if you change something"-modus we currently employ.

What do you think about this @StellaEggels ?

To clarify this would be a low priority task for @kMutagene and me, so it would take some time and rely heavily on the fact that we do not get any more pressing matters.

@kMutagene
Copy link
Member

kMutagene commented Jul 4, 2024

A few thoughts on this from my side:

  • Suggested name/url: Swate Template Registry (STR), str.nfdi4plants.org
  • Search could be completely offloaded to this service, potentially improving swate performance
  • Templates can be previewed on a simple website, without the context of running in Swate.
  • the template browsing webpages could render a full preview of the tables
  • shining more spotlight on the authors is also possible, as we could create pages for authors (a feature i would also like to implement for AVPR)
  • I do not think we can share much code between the 2 applications, as the DB schema and page templates vary . However, i would suggest to stick to the same style and technologies so the experience feels familiar across both sites.
  • We can add more nfdi branding to the pages if necessary, but that would mean we have to investigate a way to use our web components in a static-site generation context.

I will create some issues so we can track progress on this more granularly. As with AVPR, a prototype can be up quite fast, but specifics (especially embedding into the current CI processes) will take time.

@kMutagene
Copy link
Member

Another point: i think this repo should be also renamed to swate-template-registry.

@Freymaurer
Copy link
Collaborator Author

shining more spotlight on the authors is also possible, as we could create pages for authors (a feature i would also like to implement for AVPR)

Being able to find all templates by an author would be very nice i think!

We can add more nfdi branding to the pages if necessary, but that would mean we have to investigate a way to use our web components in a static-site generation context.

I think i know how to do this, but i would advise against, as the STR side would use a functional navbar (their own searchbar, navigation). Other web-components do not really apply. Maybe color scheme is enough?

@kMutagene
Copy link
Member

kMutagene commented Jul 4, 2024

Other web-components do not really apply

I think if we want branding, we are basically talking about the navbar and footer. I am however also fine with using the OOTB style that is provided by pico.css that is used on AVPR as it is quite clean and minimal while still feeling modern (dark mode support etc)

@kMutagene
Copy link
Member

shining more spotlight on the authors is also possible, as we could create pages for authors (a feature i would also like to implement for AVPR)

Being able to find all templates by an author would be very nice i think!

As a first step sure, but i think linking the info to the actual DataPLANT accounts with profile information, ORCID links etc would be even better

@StellaEggels
Copy link
Collaborator

I can’t follow all the details, but generally sounds like a good idea to me. I will rename this repository to swate-template-registry then.

@StellaEggels
Copy link
Collaborator

I guess I can't rename it :D but changing the name is fine with me, we just have to change it in the knowledge base links as well

@kMutagene
Copy link
Member

I guess I can't rename it :D but changing the name is fine with me, we just have to change it in the knowledge base links as well

No worries, I can do that. As long as we do not create a new Swate-templates repo in the future, all old links will work and point to this repo regardless of the new name

@Freymaurer Freymaurer pinned this issue Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In discussion
Development

No branches or pull requests

3 participants