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

Create issues details page #786

Open
CharliePatterson opened this issue Jan 15, 2025 · 1 comment
Open

Create issues details page #786

CharliePatterson opened this issue Jan 15, 2025 · 1 comment
Assignees

Comments

@CharliePatterson
Copy link
Contributor

CharliePatterson commented Jan 15, 2025

Context:

  • To help data providers understand which data quality issues they must fix prior to publishing and submitting their data, we are going to incorporate the Data Management team's data quality framework.
  • This will introduce the concept of "blocking" and "non-blocking" issues.
  • This will help data providers prioritise which issues to resolve first, and hopefully encourage them to take an iterative approach to providing data.
  • The results page is split into a task list (copying the pattern from the task list page on the submit service), showing three groupings:
    1. Checks that have passed
    2. Issues that must be fixed prior to publishing and submitting (aka blocking issues)
    3. Issues that can be fixed after publishing and submitting (aka non-blocking issues)
  • Each task in the list links out to an issues details page, where the user can get more information on the specific issue that they need to fix.
  • The issues details page provides more granular information about the specific data quality issue, showing which rows are affected, and helps the user to understand what the issue is and how to fix it.
  • This should enable users to better understand and address specific data issues ahead of publishing and submitting their data, thus improving the level of data quality of the data provided.
  • This ticket focuses solely on implementing the issues details page, which relies on the task list generated in this ticket for navigation and linking.

Designs / Prototype:

Acceptance criteria:

1. All issues details pages:

  • Display the organisation name and dataset name
  • Display the header: "Your data has issues"
  • Display the issue summary panel to highlight what the issue is that needs fixing (the heading in this panel should be dynamic depending on what kind of issue it is)
  • Display the table of all the data that's being checked, including:
    • Pagination of all the results
    • Ordering the columns to put reference and name first
    • Highlighting the rows with issues on the table
  • A short summary of how to fix the issue. Note, there's a separate ticket to make this dynamic, but for now we should just display the same static text that we have on the issues details page on the live service.
  • A 'back' link at the top of the page to direct the user back to the results list page.
  • A 'back' link at the bottom of the page to direct the user back to the results list page.

2. Blocking issues details pages:

  • If the issue is considered 'blocking' then the content in the issue summary panel should display the following text: "You cannot submit your data until you fix the issues"

3. Non-blocking issues details pages:

  • If the issue is considered 'non-blocking' then the content in the issue summary panel should display the following text: "You can submit your data and fix these issues later"
@neilfwar
Copy link

@GeorgeGoodall look to split blocking and non block as 2 separate tickets

@rosado rosado self-assigned this Feb 3, 2025
@rosado rosado moved this from Eng sprint backlog to In Development in Submit and update planning data service Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Development
Development

No branches or pull requests

3 participants