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

Major update for webservices at CLST, Radboud University, Nijmegen (auto-harvested) #61

Merged
merged 15 commits into from
Nov 10, 2020

Conversation

proycon
Copy link
Contributor

@proycon proycon commented Sep 30, 2020

This PR updates the tool registry for our CLAM-based webservices. There are some major changes:

  • We just finished an internal migration, our webservices are now at https://webservices.cls.ru.nl instead of https://webservices-lst.science.ru.nl , although the old links should all redirect nicely (HTTP 301), I can imagine this may be confusing to the handler on the switchboard side and possibly lead to errors in the current production environment.
  • Some webservices were removed and some new ones were added.
  • The CLAM webservice metadata has been harvested automatically and converted to the registry json format, this was done by a script which invokes by clam2switchboard tool. The actual script is included in this PR in the contrib/harvest directory (I imagine it could hold various kinds of user contributed harvesting scripts). This means you can update the tool metadata even without my intervention, by just running the script.

An extra round of testing is still required to ensure that all these all work properly. I remember you guys have nice automated systems for that right?

…tion, Grapheme to Phoneme Conversion, Transliteration, Text Normalisation, Optical Character Recognition, Handwritten Text Recognition (all of these are motivated by actual services we have in these categories)
…LAM webservices at CLST, Nijmegen and converts them to (numerous!) switchboard registry entries
…ed ones (may have different names), some are dismantled anyway
@emanueldima
Copy link
Collaborator

@proycon json validation fails, do you have access to travis? (https://travis-ci.org/github/clarin-eric/switchboard-tool-registry/builds/731614143). Most of the errors are missing logos (must be a string). You can also run the validation yourself, see the command in the travis file: https://github.com/clarin-eric/switchboard-tool-registry/blob/master/.travis.yml

@proycon
Copy link
Contributor Author

proycon commented Oct 1, 2020

Thanks, I see it now yes! I'll prepare a fix

@proycon
Copy link
Contributor Author

proycon commented Oct 1, 2020

The validation now passes successfully.

@emanueldima emanueldima merged commit 583bb92 into clarin-eric:master Nov 10, 2020
@emanueldima
Copy link
Collaborator

@andmor- @dietervu I guess we should merge this to production?

@dietervu
Copy link
Contributor

Before merging this to production, I tried to check https://beta-switchboard.clarin.eu/ and https://switchboard.clarin-dev.eu/switchboard-test/ to test-drive these changes. But it seems they are not available. Is this correct or did I overlook something?

@emanueldima
Copy link
Collaborator

@proycon Could you add a logo image for these tools? Otherwise they will be displayed with a missing logo: https://beta-switchboard.clarin.eu/tools

@proycon
Copy link
Contributor Author

proycon commented Nov 18, 2020

Good point, I'll send a new PR with some logo images soon.

@proycon
Copy link
Contributor Author

proycon commented Nov 18, 2020

It seems some of the logos that are already present are not being shown? Like frog.jpg , might this be a bug? Or do they necessarily have to pngs now?

@emanueldima
Copy link
Collaborator

Most image files are supported, an entry of "logo": "x" in the tool json file will be translated to a https://beta-switchboard.clarin.eu/api/logos/x. The frog is there, you just have to set "frog.jpg" as the logo: https://beta-switchboard.clarin.eu/api/logos/frog.jpg

@proycon
Copy link
Contributor Author

proycon commented Nov 19, 2020

That's what I thought yes, but for example the frog logo doesn't show on https://beta-switchboard.clarin.eu/tools even though the API call works.

@emanueldima
Copy link
Collaborator

I don't see any tools that have this logo in the json file, am I missing something?

@proycon
Copy link
Contributor Author

proycon commented Nov 19, 2020

Hmm, indeed, I guess I was looking in another git branch. I see now that they are missing from this PR.

@dietervu
Copy link
Contributor

FTR: I have been and am test-driving the CLAM services and once the last glitches are resolved (I'm communicating with proycon about this) this PR can be merged. I'll give an update in this thread.

@andmor-
Copy link
Member

andmor- commented Nov 23, 2020

To merge this in production the contrib/harvest has to be removed. We have to discuss this but I think that this repository is not the place for tool specific scripts (or any type of code in general)

@andmor-
Copy link
Member

andmor- commented Nov 23, 2020

I am removing it to be able to merge the metadata part to production.
If needed we can later create a new repository for code for specific tools.

@emanueldima
Copy link
Collaborator

@proycon We decided it would be better to store all contrib code in a separate repository, something like github.com/clarin-eric/switchboard-tools-contrib. We should not get foreign code in this repository as it is replicated into the switchboard instances. But we'd like to have the contrib code together in a single place. However we (e.g. clarin-eric) cannot be responsible for contrib code and should not have to maintain it. Do you think that's a good idea, would you add your contrib to this repository?

@proycon
Copy link
Contributor Author

proycon commented Nov 30, 2020

@emanueldima That sounds like a good solution yes! If you create the repo then I'll gladly push my harvest script there.

@andmor-
Copy link
Member

andmor- commented Nov 30, 2020

New repository created

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

Successfully merging this pull request may close these issues.

4 participants