search

noi-techpark / odh-docs

Open Data Hub (http://opendatahub.com/) Documentation
http://opendatahub.readthedocs.io/en/latest/index.html
3 stars 4 forks source link

ODH Domain Change #262

Closed stefanodavid closed 1 year ago

stefanodavid commented 2 years ago

The Open Data Hub domain is changing from .bz.it to .com, so we need to modify all the URLs, e-mail addresses, and so on, with one exception: the links to the API will not be changed.

We also take the chance to rename all the dataset's IDs like in this example:

it.bz.opendatahub.environment → environment.opendatahub

Piiit commented 2 years ago

The Open Data Hub domain is changing from .bz.it to .com, so we need to modify all the URLs, e-mail addresses, and so on, with one exception: the links to the API will not be changed.

OK!

We also take the chance to rename all the dataset's IDs like in this example:

it.bz.opendatahub.environment → environment.opendatahub

Could you tell me shortly where these IDs are used?

stefanodavid commented 2 years ago

Could you tell me shortly where these IDs are used?

In this docs only AFAIK.

Piiit commented 2 years ago

OK, so I would then just replace it.bz with com and keep the rest

stefanodavid commented 2 years ago

This notation was agreed upon by @mrabans and me, so I'll stick with it unless he changes his mind.

Piiit commented 2 years ago

@mrabans @stefanodavid OK fine for me, just think about a hierarchical name. Since we decided to follow this concept also in our repo naming in the future... see https://github.com/noi-techpark/it.bz.opendatahub.webcomponents or https://github.com/noi-techpark/it.bz.opendatahub.databrowser as an example

With this we have a natural sorting out of the box...

stefanodavid commented 2 years ago

We decided to skip the renaming of the datasets for the moment, we will make a deeper analysis of the datasets, also keeping in mind the mid-term to long-term evolution of ODH.

@Piiit we do not need any ordering of the datasets, they do not correspond to any website or online resource, and they are not software package, so IMVHHO it would be completely useless to rename them as com.opendatahub.whatever as you propose.

Piiit commented 2 years ago

@stefanodavid @mrabans Fine for me

Piiit commented 2 years ago

@mrabans OT: We should think about an unique name per data set for the new infrastructure... just for the future... this needs some discussions and additional implementation, so that we have the unique ID also somehow mapped inside the API response JSONs. I think, this could be useful to better guide users from API responses to documentation and vice-versa. However, it is not trivial to do it right...

mrabans commented 2 years ago

@Piiit why not use the id's already present in the Open Data Hub? Probably we should rather think about a nice tagging and categorization on the documentation side to group them up. But for the datasets itself I'd avoid to invent new names when they already exist.

image

Piiit commented 2 years ago

Agreed. That is a good idea... Better remove those artificial names and use the real ones from the API response

mrabans commented 1 year ago

We now have two places where datasets are presented:

In future most probably the Open Data Hub will publish this information with a dedicated API.

So for now we can remove this section from RTD and do an indication to the website opendatahub.com.

See #263 for this todo.

stefanodavid commented 1 year ago

I forgot to remove an outdated link

stefanodavid commented 1 year ago

reopened a wrong branch (it's Friday, I'm in love)