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

Describe isPartOf relations in DCAT-US dataset as Collection in catalog-next #4969

Open
9 tasks
FuhuXia opened this issue Nov 6, 2024 · 1 comment
Open
9 tasks
Labels
H2.0/Harvest-General General Harvesting 2.0 Issues

Comments

@FuhuXia
Copy link
Member

FuhuXia commented Nov 6, 2024

User Story

In order to show relations of DCAT-US datasets linked to each other with isPartOf field, data.gov teams wants group those datasets into Collections in the catalog-next.

Acceptance Criteria

[ACs should be clearly demoable/verifiable whenever possible. Try specifying them using BDD.]

Parent dataset behavior:

  • GIVEN a dataset's identifier is the value of isPartOf field of other datasets
    AND they are from the same harvest source
    WHEN the dataset is listed in a search result
    THEN a collection icon shows up to indicate it is a Collection \

  • GIVEN a dataset's identifier is the value of isPartOf field of other datasets
    AND they are from the same harvest source
    AND all children datasets are in the deleted state
    WHEN the dataset is listed in a search result
    THEN there is NO collection icon to this dataset \

  • GIVEN a dataset's identifier is the value of isPartOf field of other datasets
    AND they are from the same harvest source
    WHEN the dataset detail page is visited
    THEN there is a block to indicate this is a Collection
    AND there is a link to the Collection page.

  • GIVEN a Collection page is visited
    THEN all the collection's children datasets are listed
    AND you can search within this Collection.

Children dataset behavior:

  • GIVEN a dataset with a value for isPartOf value
    THEN the dataset is hidden from normal search result
    AND does not count in the total dataset count

  • GIVEN a dataset with a value for isPartOf value
    THEN the dataset is listed in its Collection page

  • GIVEN a dataset with a value for isPartOf value
    THEN the dataset detail page should indicate it is part of a Collection.

  • GIVEN a dataset with a value for isPartOf value
    AND the parent dataset is active
    THEN the dataset detail page should have a link to the parent dataset.

  • GIVEN a dataset with a value for isPartOf value
    AND the parent dataset is not active (deleted or does not exist)
    THEN the dataset detail page should have a link to its Collection page

Background

The UI should be similar to the Collection in the existing catalog.data.gov. The difference is that there is no additional CKAN field in the extras collection_metadata=true to indicate a parent(collection) dataset. The collection relations are built by querying SOLR index with harvest_source_id and isPartOf values.

Security Considerations (required)

[Any security concerns that might be implicated in the change. "None" is OK, just be explicit here!]

Sketch

[Notes or a checklist reflecting our understanding of the selected approach]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
H2.0/Harvest-General General Harvesting 2.0 Issues
Projects
Status: 📥 Queue
Development

No branches or pull requests

2 participants