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

Add terms definitions into H2.0 UI #4979

Open
3 tasks
tdlowden opened this issue Nov 25, 2024 · 1 comment
Open
3 tasks

Add terms definitions into H2.0 UI #4979

tdlowden opened this issue Nov 25, 2024 · 1 comment
Assignees

Comments

@tdlowden
Copy link
Member

tdlowden commented Nov 25, 2024

User Story

As a harvest source POC, I want a way to view the definitions or correlated meanings of terms, so that I can better understand my harvest source information

  • Frequency
  • Source_type
  • Schema_type
  • Records with CKAN_id
  • Email
  • Records_ignored
  • Job errors vs record errors
  • Cited job/harvest/org IDs
  • record errors messages

Acceptance Criteria

  • GIVEN a harvest source POC visits the H2.0 UI
    WHEN job or harvest pages are visited
    THEN key terms listed above should have a link or glossary or hover effect to define them

Background

https://docs.google.com/document/d/1ktdicfssXhtjyYnkdvi1q7GCEDDMWAfv1kDrvnxUcL8/edit?tab=t.0

Security Considerations (required)

None

Sketch

  • Decide most appropriate way to surface key term definitions (hover, glossary, etc)
  • Implement chosen method in H2.0 UI
@rshewitt
Copy link
Contributor

rshewitt commented Jan 14, 2025

  • Frequency
    • how often the harvest source is harvested ( i.e. extracted, transformed, and loaded into our catalog ). examples are "weekly", "daily", and "manual"
  • Source_type
    • either a single document ( e.g. data.json ) or a web-accessible folder with many documents
  • Schema_type
    • the metadata standard of the document(s). examples include ISO19115-1, ISO19115-2, CSDGM, and DCAT-US. only 1 schema can be used per harvest source.
  • Records with CKAN_id
    • we use a combination of open source and in-house software in our harvesting. currently, our records are synchronized between these 2 systems by pairing the id of the record in our in-house database with our open source (i.e. CKAN) database.
  • Email
    • an email address to receive harvesting information
  • Records_ignored
    • our harvesting process pulls data from our internal database and your external source and compares them to determine which records need to be created, updated, deleted, or ignored on our end. "ignored" means nothing needs to be done. we have the most recent copy of your record. in comparison to "created", let's say, where we don't have a copy of your record and need to create it on our end.
  • Job Errors
    • also known as "critical" errors are ones which prevent the harvester from determining which operations to run on records. for example, if the harvester receives a 404 http error code when attempting to download your document this would produce a "Job Error".
  • Record Error
    • also known as "non-critical" errors are ones which occur at the record level after the harvester has determined which operations to run. examples include validation and transformation failure.

Cited job/harvest/org IDs
record errors messages

@rshewitt rshewitt self-assigned this Jan 15, 2025
@rshewitt rshewitt moved this from 📥 Queue to 🏗 In Progress [8] in data.gov team board Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 🏗 In Progress [8]
Development

No branches or pull requests

2 participants