Skip to content

Capture harvest source descriptions #5390

Description

@jbrown-xentity

User Story

In order to capture harvest source subscriptions, data.gov admins (and data providers) want the H2.0 model updated to allow for a description.

Acceptance Criteria

  • GIVEN the Harvest 2.0 model is updated
    WHEN a sync between CKAN and H2.0 occurs
    THEN the description (where available) is available on H2.0.

Background

See prod example here: https://catalog.data.gov/harvest/about/census-5-digit-zip-code-tabulation-area-zcta5-national

Ironically, the description is cut off in the view. However, as we lack context on many of these harvest sources, it will be helpful to have this information for future.

Security Considerations (required)

None

Sketch

This would involve a DB migration, but only adding a field (which is minor by DB migration standards).

  • Add description to the harvest_source table model via a migration.
  • Validate working, and release through dev/stage/prod.
  • Write script to download all the descriptions and update the corresponding harvest source in H2.0. It should be assumed (unless proven otherwise) that the name is the matching field between the 2 systems.
  • Validate/update the harvest source page (UI) to show the description.

Activity

  1. jbrown-xentity commented on Aug 14, 2025

    @jbrown-xentity
    ContributorAuthor

    catalog-harvest-info.json is the current harvest source info to add in (in case this is done after the CKAN harvester is gone).

  2. moved this to 📥 Queue in data.gov team boardon Aug 21, 2025
  3. moved this from 📥 Queue to New 📤 Queue in data.gov team boardon Sep 16, 2025
  4. moved this from New 📤 Queue to 📥 Queue in data.gov team boardon Sep 16, 2025
  5. moved this from 📥 Queue to Queue for Next Sprint in data.gov team boardon Jan 29, 2026
  6. SueValente commented on Feb 12, 2026

    @SueValente
    Contributor

    Describe the harvest source. (Does not relate to publisher).

  7. moved this from Queue for Next Sprint to 📥 Queue in data.gov team boardon Feb 25, 2026
  8. moved this from 📥 Queue to No status in data.gov team boardon Mar 10, 2026
  9. 7 remaining items

  10. moved this from 📥 Queue (up next) to 📟 Sprint Backlog (Top Priority) in data.gov team boardon Sep 8, 2026
  11. self-assigned this
    on Sep 16, 2026
  12. moved this from 📟 Sprint Backlog (Top Priority) to 🏗 In Progress in data.gov team boardon Sep 17, 2026
  13. added theissue type on Sep 17, 2026
  14. moved this from 🏗 In Progress to 👀 Needs Review in data.gov team boardon Sep 21, 2026
  15. moved this from 👀 Needs Review to ✔ Done in data.gov team boardon Sep 23, 2026
  16. moved this from ✔ Done to 🏗 In Progress in data.gov team boardon Sep 23, 2026
  17. jaredb96 commented on Sep 24, 2026

    @jaredb96

    Ran script to add descriptions to harvest sources from the json above @SueValente @jbrown-xentity. Results:

    • 797 sources in prod
    • 613 updated with new descriptions
    • 165 skipped because they had empty descriptions in JSON
    • 19 sources exist in prod but not in the json file
  18. jbrown-xentity commented on Sep 24, 2026

    @jbrown-xentity
    ContributorAuthor

    @jaredb96 I saw the description addition yesterday during DCAT-US3 office hours! Very helpful added search.

    Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions