NCBI testing release 23 Feb
Hi @lathrops1
The main functionality in this release is the support for publishing Collection TOCs
Feature: Publishing Collections TOCs
I'm copying below the workflow as described at the epic: &3. These are the steps your team should follow when testing.
- A sys admin creates a collection and chooses the relevant TOC settings - these update the related domain settings via the domain service.
- When the collection is created, the collection.xml file is created and the TOC has status "unpublished"
- Whenever collection metadata is edited the BCMS writes
<collection-meta>
node into the collection.xml file (as spec'd in #815 (closed)) - Only Sys Admins can publish a TOC (until Preview workflow is supported)
- The TOC package is created to XML wholebook specifications (#387 (closed)) and is sent whenever a user selects "Publish" and "Update published version" buttons.
- The BCMS runs agreement API checks on collection domain (as done in #481 (closed))
- The BCMS runs release checks on collection domain (as done in Use case 1 and 2 in #435 (closed))
- NCBI adds the
collection-list
to the collection.xml - NCBI sends kafka notification (success or error)
- BCMS displays live preview or errors, depending on above
Please note
- Any existing Collection TOC will have a status "unpublished" even if it's been published before. Simply select "Publish" to regenerate.
- Any existing Book TOC will have a status "unpublished" even if it's been published before. Simply select "Publish" to regenerate. This will only be possible if there is at least one published chapter.
- To see a Collection TOC published with its book-members, the book must published first, as Martin confirmed in here: #1026 (comment 81711)
The issues relating to the above include:
Issue | Title | State | Milestone | Epic ID | Epic Title |
---|---|---|---|---|---|
#816 (closed) | Update, package and send collection.xml for publishing | Closed | 2022-Feb-A | 3 | Collection TOC management |
#882 (closed) | Support for collection files | Closed | 2022-Feb-A | 3 | Collection TOC management |
#884 (closed) | Published date and statuses for collections | Closed | 2022-Feb-A | 3 | Collection TOC management |
#957 (closed) | Email notification: Metadata Modified by User | Open | 2022-Feb-A | 23 | Set up: Metadata |
#991 (closed) | Collection TOC page frontend | Closed | 2022-Feb-A | 3 | Collection TOC management |
#1032 (closed) | Back navigation from Collection TOC page should take user to Collection manager page | Closed | 2022-Feb-B | 3 | Collection TOC management |
Feature: Funded content setting integrations: Author MS; Prepublication draft; Published PDF
When a chapter or TOC is loaded to PMC (either automatically or by selecting a button in the UI) that belongs to a funded collection and contains a "funded content type" setting, the BCMS write PIs to the metadata. All use cases are specified in the issue:
Issue | Title | State | Milestone | Epic ID | Epic Title |
---|---|---|---|---|---|
#676 (closed) | Funded content setting integrations: Author MS; Prepublication draft; Published PDF | Closed | 2022-Feb-B | 51 | Meta Funding |
Design improvements
The following design improvements are included. All testing information is in the issue.
Issue | Title | State | Milestone | Epic ID | Epic Title |
---|---|---|---|---|---|
#978 (closed) | Removing a book from a collection | Closed | 2022-Feb-A | 22 | Set up: Settings |
#1034 (closed) | Improvement: Allow Book TOC to be published manually for the first time | Closed | 2022-Feb-B | 2 | Chapter-processed TOC management |
Bugs
The following bugs are included. All testing information is in the issue.
Bugs identified as migration blockers
Issue | Title | Milestone |
---|---|---|
#888 (closed) | Not all book part metadata is getting written into TOC.xml - suffix is missing | 2022-Feb-A |
#932 (closed) | Link styling button for the "Copyright Statement" field in metadata templates doesn't work | 2022-Jan-A |
#942 (closed) | Book editor supplied in UI by user not written into book metadata | 2022-Jan-B |
#984 (closed) | Table of contents setting from Org and Collection template not applied to books | 2022-Feb-A |
Additional bugs identified as as priorities to fix before deployment
Issue | Title | Milestone | Epic ID | Epic Title |
---|---|---|---|---|
#854 (closed) | Open Access collections setting should be locked and only editable by SysAdmin | 2022-Feb-B | 22 | Set up: Settings |
#855 (closed) | UKPMC collections setting should be locked and only editable by SysAdmin | 2022-Feb-B | 22 | Set up: Settings |
#939 (closed) | Public domain licenses do not meet tagging guidelines causing loading errors | 2022-Feb-B | 55 | Meta Book (chapter-processed) |
#976 (closed) | Books part of a group in a collection, if moved to another collection creates duplicate | 2022-Feb-A | 3 | Collection TOC management |
#998 (closed) | Remove "grants" id and apply fields and values from JSON files |
2022-Feb-B | 51 | Meta Funding |
#1030 (closed) | do not write empty metadata nodes in book AND collection xml | 2022-Feb-B | 3 | Collection TOC management |
#1031 (closed) | Books added to collection sometimes don't show in collection | 2022-Feb-B | 3 | Collection TOC management |
#1033 (closed) | Book status does not update to match chapters (when there is only one chapter) | 2022-Feb-B | ||
#1042 (closed) | Org admins should have access to all collections in their org | 2022-Feb-B |
NB for your testing
I am getting a UI error Unexpected token < in JSON at position 0
when I try to publish a Word chapter in specific books only. This is likely a migration issue but we'll need to investigate tomorrow morning. If this does happen, please do the following:
- Check the required book metadata fields are provided, try publish again
- If this doesn't work, open a bug issue with link to the specific chapter.