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

Update some CKAN properties #265

Merged
merged 14 commits into from
Feb 27, 2024
Merged

Update some CKAN properties #265

merged 14 commits into from
Feb 27, 2024

Conversation

@ludovicm67 ludovicm67 self-assigned this Feb 14, 2024
Copy link

changeset-bot bot commented Feb 14, 2024

🦋 Changeset detected

Latest commit: 54a554d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@zazuko/trifid-plugin-ckan Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@ludovicm67 ludovicm67 marked this pull request as draft February 14, 2024 10:25
@ludovicm67
Copy link
Member Author

For the Dataset > Publisher, this is the current output:

<dcterms:publisher>
  <rdf:Description>
    <rdfs:label> Schweizerisches Bundesarchiv</rdfs:label>
  </rdf:Description>
</dcterms:publisher>

The handbook says that we should have the following structure:

<dct:publisher>
  <foaf:Organization rdf:about="https://swisstopo">
    <foaf:name>Landesamt für Topographie Swisstopo</foaf:name:>
  </foaf:Organization>
</dct:publisher>

I did a commit that generates an output like this:

<dcterms:publisher>
  <foaf:Organization>
    <foaf:name> Schweizerisches Bundesarchiv</foaf:name>
  </foaf:Organization>
</dcterms:publisher>

@ludovicm67
Copy link
Member Author

I removed the checkboxes for the new properties, as this PR is for converting existing ones into the new format.

@ludovicm67
Copy link
Member Author

The Dataset > accrual periodicity property is already up-to-date :)

@ludovicm67
Copy link
Member Author

I removed the checkbox for the Dataset > qualified relation property, as we are not using rdfs:seeAlso in the current state.

@ludovicm67
Copy link
Member Author

ludovicm67 commented Feb 14, 2024

Questions about the remaining points:

  1. Dataset > theme: is there a mapping between the old and the new format? If so, do you think it makes sense to convert them on the fly?

  2. Dataset > landingPage: in the code serializeTerm is used ; this means it can come as any format? If so, what would be the best way to get it as a string to use it as a property?

  3. Dataset > related resource: is it something that we need to take care about?

  4. Distribution > format: is there a mapping between the old and the new format? If so, do you think it makes sense to convert them on the fly? Also how do we represent an unknown format?

  5. Distribution > rights: is it something we need to take care about? As the value we had is now set as license, and that they are describing that rights should be used for exceptional use only

And also, should we do the release as a major version, as the format is different, or as a patch, as it fixes the format to be compliant, or something in between?

packages/ckan/src/xml.js Outdated Show resolved Hide resolved
@tpluscode
Copy link
Contributor

Dataset > theme: is there a mapping between the old and the new format? If so, do you think it makes sense to convert them on the fly?

I would add that mapping in Lindas metadata

Dataset > landingPage: in the code serializeTerm is used ; this means it can come as any format? If so, what would be the best way to get it as a string to use it as a property?

If the landing page is a string, the output matches the deprecated syntax expected by CKAN. I think that's acceptable

Dataset > related resource: is it something that we need to take care about?

Won't hurt to add, although it's probably not used by any Lindas cube. Only I see that legalBasis is now using that property...

@MartinaElsawy
Copy link

@ludovicm67 who can open the remaining questions for you?

@ludovicm67
Copy link
Member Author

@ludovicm67 who can open the remaining questions for you?

@MartinaElsawy I would say mostly us internally for now:

  • decide what will be done in Cube Creator, what needs to be done here
  • decide if it makes sense to use some new properties
  • see if there is a mapping with old properties format ; see how to update this properly

And this may also involve data publishers or maybe people at OpenDataSwiss.

@MartinaElsawy
Copy link

@ktk who you want to take the lead internally to not lose track?
I can support with getting in contact with other stakeholders as soon as we verbalised official questions/requirements for other stakeholders outside Zazuko

@tpluscode
Copy link
Contributor

@ludovicm67 IMO we don't need to do anything about landing page. The code already serializes IRIs and it's up to publishers to switch

@tpluscode
Copy link
Contributor

I removed the checkboxes for the new properties, as this PR is for converting existing ones into the new format.

Ah ah, and I just reverted them. I propose to create an issue with the full list and keep this PR only limited to what we want to ship now

@tpluscode tpluscode marked this pull request as ready for review February 27, 2024 15:03
@tpluscode
Copy link
Contributor

@ludovicm67 I moved the checklist to #280 to track those props we might implement later

Of the changes we have Dataset qualified relation and Distribution rights. The former is optional and the latter is not mandatory either. We also do not use either property. I'd say we release the current state and address the rest of the point at a later time

@ludovicm67
Copy link
Member Author

Ok, fine for me 👍

@tpluscode tpluscode merged commit 3cf0f61 into main Feb 27, 2024
3 checks passed
@tpluscode tpluscode deleted the ckan-properties-upgrade branch February 27, 2024 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants