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

Description between the openEO UDP and its algorithm docs do not match #61

Open
rahmandawibowo-vito opened this issue Nov 12, 2024 · 1 comment

Comments

@rahmandawibowo-vito
Copy link
Contributor

I notice on multiple occasions that we set the description differently between the algorithm's markdown docs and the openEO UDP description. One of the latest example can be taken from this PR #57 where I need to update the EURAC Photovoltaic Farms's UDP description to match with its markdown doc.

To add more context, the catalogue site we develop on this repo https://github.com/ESA-APEx/apex-algorithms-catalogue-web are serving detail pages that consume the description from the openEO UDP json file. Because of that, on the EURAC example https://algorithm-catalogue.apex.esa.int/apps/eurac_pv_farm_detection, the page shows rather simple information.

Image

Whereas its markdown doc actually has more complete information.

Image

I think ideally the client that consume and display the openEO UDP should easily refer to the description property, but probably there are already some vision for the APEx algorithm project which I'm not aware of. So the discussion would be:

  • Is it normal for the description on these two places to be different?
  • If so, which description should the catalogue site display? The algorithm's markdown docs or the openEO UDP one?
@rahmandawibowo-vito rahmandawibowo-vito changed the title Descriptions between openEO UDP and its algorithms docs do not match Description between openEO UDP and its algorithms docs do not match Nov 12, 2024
@rahmandawibowo-vito rahmandawibowo-vito changed the title Description between openEO UDP and its algorithms docs do not match Description between the openEO UDP and its algorithm docs do not match Nov 12, 2024
@soxofaan
Copy link
Contributor

FYI: I think I have basically the same question in #62

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

2 participants