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

Human facing docs of the web services? #72

Closed
maelle opened this issue Mar 11, 2022 · 12 comments
Closed

Human facing docs of the web services? #72

maelle opened this issue Mar 11, 2022 · 12 comments
Assignees

Comments

@maelle
Copy link
Collaborator

maelle commented Mar 11, 2022

That's something we need, especially before submitting the package to rOpenSci.

@maelle
Copy link
Collaborator Author

maelle commented Mar 11, 2022

https://emodnet.ec.europa.eu/en/data linked in the README is broken.

@maelle
Copy link
Collaborator Author

maelle commented Mar 11, 2022

@maelle
Copy link
Collaborator Author

maelle commented Mar 11, 2022

WFS supports a variety of WFS output formats (Ex: GML, shapefile, json, geojson, CSV,...)

@maelle
Copy link
Collaborator Author

maelle commented Mar 11, 2022

At the bottom of that page there are links to docs such as https://www.emodnet-biology.eu/emodnet-biology-api

@maelle
Copy link
Collaborator Author

maelle commented Mar 11, 2022

I've read https://www.emodnet-biology.eu/emodnet-biology-api and it mentions less layers than what we get via the package.

@maelle
Copy link
Collaborator Author

maelle commented Mar 11, 2022

The ones that have an abstract via emodnet_get_wfs_info() are the ones that are described in the human facing docs.

@maelle
Copy link
Collaborator Author

maelle commented Mar 11, 2022

Should we advise users to make sure they read the human-facing docs, or can we fear these get out of sync?

@salvafern
Copy link
Collaborator

This is happening because of the EMODnet migration to the europa.eu domain, it is likely that the links break, but the central portal maintains the documentation updated (although not redirecting the old link to the new one...) and VLIZ maintains the EMODnet-Biology webservice documentation, which will also be moved, no idea when tho.

At least in biology, not all layers are intended to be useful for users - some of them are needed for the infrastructure of the download toolbox. Not sure the exact purpose of all of them tho, we can ask. The ones described in the docs are the important ones to get occurrence data (and the ones being used both by the download toolbox and the eurobis R package).

Should we advise users to make sure they read the human-facing docs, or can we fear these get out of sync?

Yes! They should read the docs.

@maelle
Copy link
Collaborator Author

maelle commented May 6, 2022

Thanks @salvafern!

So what general link should we point users to? (from where they could find all docs)

@maelle
Copy link
Collaborator Author

maelle commented Oct 7, 2022

👋 @salvafern, is there now a general link we should point users to when they look for human facing docs of the web services? Thank you. 😸

@salvafern
Copy link
Collaborator

Hi @maelle , sorry for the late reply!

Still this is the main general link with documentation of the web services: https://emodnet.ec.europa.eu/en/emodnet-web-service-documentation

The EMODnet Central Portal team is currently busy with the migration of the thematic lots. In the following months there should be more clarity - or we will be able to ask them for better documentation.

@maelle
Copy link
Collaborator Author

maelle commented Oct 14, 2022

Thank you @salvafern!!

@maelle maelle closed this as completed in 5584b33 Oct 14, 2022
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

3 participants