Draft Proposal: Redesign of reporting errors in the BCMS
Context
This proposal is an outcome of the recent scoping sessions (#1220 (closed))
Proposal
User stories
- As a user I want to see all errors that relate to my content with all possible "troubleshooting references" so that I can understand the errors, how to fix them, and have a record of which errors have been fixed.
- As a user I want to to able to search all errors that relate to my content so that I can find the current ones easily and compare related errors.
Description of change
Redesign the structure of error reporting per content component (Book/Chapter/TOC) so that errors are not grouped by "Job ID". Instead show all errors in a table, in sequential order with the most recent at the top. Each error must include whichever "troubleshooting references" that the BCMS is able to provide -- this depends on the type of error and the information NCBI provides (for example: Job ID, Task manager session link, file version, package name).
Description of added functionality
- filter by: status, assignee, severity, converted file version number
- search in columns: error name, error message, Job ID, session ID
Design
Error tab: filter options and values
Error tab: table column data
- Always provided in table: name, date, severity, assignee, error message
- Provided depending on type of error: converted filename and version, Job ID, session ID
Error tab: redesign to include link to NCBI's help documentation
Instead of showing help text above the table (as currently done), move the link to NCBI's help documentation to the "show help" element. This is logical from the user's perspective and saves screen space.
Implementation (if applicable)
[A description of the steps to implement the feature.]
Alternative approaches (if applicable)
[Include any alternatives to meet this use case.]
Open issues (if applicable)
This proposal deals with feedback in the below issues. Once this proposal is accepted, these issues should be closed. The Coko team will create new development issues to schedule the work described in this proposal.