noi-techpark / it.bz.opendatahub.databrowser

Explore and navigate through Open Data you need to build your next service.
https://databrowser.opendatahub.com
GNU Affero General Public License v3.0
8 stars 7 forks source link

As a Open Data Hub developer I want that Deprecated endpoint are hidden from the list of Dataset, to avoind to give visibility to deprecated endpoints #389

Closed sseppi closed 8 months ago

sseppi commented 1 year ago

By testing the Data Browser I noted that also deprecated endpoint ("Deprecated":true) are visible in the Dataset Overview: https://v2-beta.databrowser.opendatahub.com/dataset-overview

Screenshot from 2023-06-08 08-53-55

I would suggest to so:

We don't have to give visibility to deprecated datasets/endpoints since those datasets/endpoints will be shut down after 2 years of deprecation. So we have to avoid that new Open Data Hub data consumer starts to using it.

@pkritzinger @gappc what do you think?

gappc commented 1 year ago

@sseppi fully agree with what you said in this issue, but for god's sake: stop putting stuff into Milestone 2.3 ;) It's already overly full and it won't speed up development if we keep putting stuff there, it will just make all planning obsolete. Could we please hear us and discuss the planning procedure?

pkritzinger commented 1 year ago

@sseppi @gappc I had a look at it and think that the current solution is pretty good? Showing that a dataset is deprecated could be a relevant information for people who have implemented its API. Or where do they get that information from? Maybe we could create a badge for deprecated datasets and also show when they will be shut down?

image

sseppi commented 1 year ago

Hi @pkritzinger ,

thank you for your feedback and I will try to answer you below.

@sseppi @gappc I had a look at it and think that the current solution is pretty good?

Be worry, the deprecation information you marked in the screenshot in the Title has been put by me and not automatically.

Showing that a dataset is deprecated could be a relevant information for people who have implemented its API. Or where do they get that information from?

The communication of deprecation will be done through other channels that the Data Browser. For example we send periodically emails to our community to communicate this things. Moreover, people that are already consume the data from deprecated APIs will still have access to it through a direct link.

The experience we have, is that if we leave the Dataset in the list with a Deprecated label, people ignore this information and use the deprecated calls anyway. For this reason we internally agreed to hide the deprecated datasets from the Dataset Overview.

Maybe we could create a badge for deprecated datasets and also show when they will be shut down?

Good idea to have a badge, so also people that have a direct link will have a clear information.

sseppi commented 1 year ago

The team agreed to proceed with the idea proposed in the previous comment.

The only feature to be added is the possibility to activate also deprecated endpoints. Per default the Dataset Overview will list only non deprecated dataset/endpoints.

@Mazzolintis and @pkritzinger will prepare a design proposal for the next meeting.