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.

Sign up for GitHub

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

Jump to bottom

Include CodeMeta schema out of the box #7844

Closed
poikilotherm opened this issue May 4, 2021 · 3 comments · Fixed by #7877
Closed

Include CodeMeta schema out of the box #7844

poikilotherm opened this issue May 4, 2021 · 3 comments · Fixed by #7877
Labels
Feature: Admin Guide Feature: Installation Guide Feature: Metadata Feature: Search/Browse Feature: User Guide HERMES related to @hermes-hmc work on Dataverse code Type: Feature a feature request User Role: Curator Curates and reviews datasets, manages permissions User Role: Depositor Creates datasets, uploads data, etc.
Milestone
5.13

Comments

@poikilotherm
Copy link
Contributor

poikilotherm commented May 4, 2021 •
edited

Resulting from the Software, Workflows & Containers Working Group discussions, we want to implement different changes within the Dataverse software.

A first low hanging fruit is the addition of the CodeMeta metadata schema for scientific software. Providing it out-of-the-box for any (new) Dataverse installation and adding to existing instances with upstream support greatly enhances Dataverse. This issue has none to low impact on software development resources.

A solution involves at least:

  • Adding the schema as a TSV filebase custom metadata block (along with the existing ones)
  • Adding docs to the guide about its existance, linking to the project etc
  • Adding a release notes doc

This might involve in this first step or as aftermath little code contributions to enable for #6289.
@poikilotherm poikilotherm mentioned this issue May 7, 2021
Open
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue May 17, 2021
@poikilotherm
feat(metadata): add metadata block for CodeMeta IQSS#7844
998cd74
@poikilotherm poikilotherm mentioned this issue May 17, 2021
Merged
3 tasks
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue May 18, 2021
@poikilotherm
fix(metadata): fix wrong tab in CodeMeta and rephrase softwareVersion…
73fbc0b 
… watermark helptext IQSS#7844
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue May 18, 2021
@poikilotherm
fix(metadata): add standard name to Codemeta MDB displayName. IQSS#7844
fcc36d0
This was referenced May 20, 2021
Closed
Open
@poikilotherm poikilotherm added the HERMES related to @hermes-hmc work on Dataverse code label Nov 7, 2021
@poikilotherm poikilotherm mentioned this issue Nov 19, 2021
Open
@poikilotherm poikilotherm mentioned this issue Jan 20, 2022
Closed
@poikilotherm poikilotherm mentioned this issue Mar 29, 2022
Closed
@abujeda abujeda mentioned this issue Apr 22, 2022
Closed
pdurbin added a commit that referenced this issue Jul 19, 2022
@pdurbin
get codemeta.tsv to load (displayOrder, mostly) #7844
5655683
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Jul 22, 2022
@poikilotherm
feat(metadata): add metadata block for CodeMeta IQSS#7844
98f21ea
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Jul 22, 2022
@poikilotherm
fix(metadata): fix wrong tab in CodeMeta and rephrase softwareVersion…
3c497a1 
… watermark helptext IQSS#7844
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Jul 22, 2022
@poikilotherm
fix(metadata): add standard name to Codemeta MDB displayName. IQSS#7844
492491e
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Jul 22, 2022
@poikilotherm
fix(metadata): make CodeMeta TSV usable IQSS#7844
382c1e4 
- Add missing displayOrder values
- Fix missing type for software requirements
- Avoid splitting up compound fields too much,
  otherwise data is not exportable to schema.org
  or CodeMeta JSON-LD without special handling (IQSS#7856)
- Tweak order
- Tweak descriptions and examples
- Fix whitespaces and line endings
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Jul 22, 2022
@poikilotherm
feat(metadata): add i18n properties for CodeMeta IQSS#7844
1e8567d
@jggautier jggautier mentioned this issue Jul 22, 2022
Open
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Aug 1, 2022
@poikilotherm
refactor(metadata): move CodeMeta to experimental IQSS#7844
c6c669c 
With the merge of computational workflow metadata considered
experimental, move CodeMeta there, too.
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Nov 10, 2022
@poikilotherm
refactor(metadata): rename CodeMeta softwareVersion to codeVersion IQ…
c4e5028 
…SS#7844

As the citation block already contains a compound field "software"
with both "softwareName" and "softwareVersion", meant to describe software
used to create the dataset, this name conflict must be resolved.

By renaming to "codeVersion", the semantic is not changed, as this metadata
block is about describing software deposits. As the termURI is explicitly
set to "schema.org/softwareVersion" it remains compatible with OAI-ORE and
other linked data usages. A future exporter for CodeMeta might require
special attention for this field.
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Nov 10, 2022
@poikilotherm
style(metadata): rephrase CodeMeta storage and memory requirements de…
d79b4aa 
…scriptions IQSS#7844

A slight rephrasing should make it easier to understand what is expected
as content for these metadata fields.
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Nov 10, 2022
@poikilotherm
feat(metadata): add CodeMeta fields to Solr schema IQSS#7844
8d5edf2 
Adding the fields of the CodeMeta block to the Solr schema
to enable quick usage of the fields (despite being flagged experimental in the guides).
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Nov 30, 2022
@poikilotherm
doc: add release note for CodeMeta block IQSS#7844
8b9d7f5
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Dec 13, 2022
@poikilotherm
revert(metadata): remove CodeMeta fields from Solr schema IQSS#7844
9dcbfa0 
This reverts commit 8d5edf2.

@IQSS decided we will not include fields from experimental blocks
in the schema.
@poikilotherm poikilotherm mentioned this issue Dec 13, 2022
Closed
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Dec 21, 2022
@poikilotherm
fix(metadata): remove typos from CodeMeta files IQSS#7844
f1a84b4
@pdurbin pdurbin added this to the 5.13 milestone Dec 21, 2022
@mreekie
Copy link

mreekie commented Jan 4, 2023 •
edited

Found this in the global backlog today in the sprints tab.
Not sure how it got here.
Looks to be associated with PR #7877 which was part of the Dec 15, 2022 sprint.
Adding it to that sprint.
It does not have any points so it won't impact the sprint velocity.

@pdurbin
Copy link
Member

pdurbin commented Jan 4, 2023

Right, not just associated but closes. So merging the PR closed the issue.

@mreekie
Copy link

mreekie commented Jan 11, 2023 •
edited

Right, not just associated but closes. So merging the PR closed the issue.

Got it. Get it. :) This represents one of those corner cases from my point of view of tracking our progress. The dev team got the PR, sized it and worked it. However, there was also an issue associated with it (This issue). It confused me when it popped up after the fact on my radar.

Thinking out loud, but I'm thinking that since we didn't take this issue into account in the planning, let's not insert it later in the tracking process by adding the Sprint label. The two will still remain associated by the issue/PR relationship.

This raises another thing too. If someone other than me sets that label arbitrarily it will make the tracking harder. I'm not sure at this point how to make everyone aware not to do that.

^^ This all assumes that the issue and the PR were not both in the backlog at the same time. That represents I guess another corner case to the backlog grooming.

Still - for now, I'll remove this issue from the backlog project and call it done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Feature: Admin Guide Feature: Installation Guide Feature: Metadata Feature: Search/Browse Feature: User Guide HERMES related to @hermes-hmc work on Dataverse code Type: Feature a feature request User Role: Curator Curates and reviews datasets, manages permissions User Role: Depositor Creates datasets, uploads data, etc.
Projects
None yet
Milestone
5.13
Development

Successfully merging a pull request may close this issue.

7844 codemeta schema poikilotherm/dataverse
3 participants
@pdurbin @poikilotherm @mreekie