ncbi issueshttps://gitlab.coko.foundation/ncbi/ncbi/-/issues2020-02-14T14:08:11Zhttps://gitlab.coko.foundation/ncbi/ncbi/-/issues/10Set up project management2020-02-14T14:08:11ZDione Mentisdione@coko.foundationSet up project managementThis is my work in progress
* [x] Project wiki: This needs to include all project information for Coko and NBCI team. I'll set up first version and then create an issue for other sections that needs to be written.
* [x] Quick communica...This is my work in progress
* [x] Project wiki: This needs to include all project information for Coko and NBCI team. I'll set up first version and then create an issue for other sections that needs to be written.
* [x] Quick communication: Mattermost group that for Coko and NCBI team
* [x] Project schedule: as Milestones in Gitlab
* [x] Tagging system for issues: We need more than we have currently ('to do', 'doing', 'done', 'on hold')
* [x] Sharing documents with NCBI: client-share folder in Nextcloud
* [x] Agree on meeting rituals: with NCBI
* [x] Agree on meeting rituals: internal
* [x] Invite Henrik to repo
* [x] Invite NCBI team to repoDione Mentisdione@coko.foundationDione Mentisdione@coko.foundation2020-02-14https://gitlab.coko.foundation/ncbi/ncbi/-/issues/6Questions on workflow and data modeling of the app2020-11-10T18:36:46ZGiannis Kopanasjkopanas@gmail.comQuestions on workflow and data modeling of the appGathering here questions that came up while working on data modeling.
* [x] 1. are reviews and comments related? Comments can be made only during "review" status of the book?
Comments relate to a book component version (chapter-proc...Gathering here questions that came up while working on data modeling.
* [x] 1. are reviews and comments related? Comments can be made only during "review" status of the book?
Comments relate to a book component version (chapter-processed) or a book version (book-processed)
* [x] 2. Does review mean a new version of the original book (replaced files, comments, decisions)?
Reviews happen per book component version (chapter-processed) or a book version (book-processed). A new version is created after 'Published' state
* [x] 3. What are the things that we want to track during the lifecycle of a book ? is there a need to revert to a previous state by reading the tracked events
List of activity to track for user activity stream and production reports in #209.
There is no need to revert to a previous state of the content.
* [x] 4. Preview functionality is happening only during REVIEW status? What actually is a preview of the book? Rendered content of all the chapters? using PageJS for example?
Preview link generated by NCBI and sent to BCMS. Available to view during all states except Converting and Errors
* [x] 5. only the latest generated preview is saved ? or do we need versioning on previews?
Only the latest file version
* [x] 6. Identify metadata of a book
Done in #142
* [x] 7. What are the User Preferences?
Email notification preferences (scoped at this stage for one-to-one or daily digest) #252
* [x] 8. What is the difference between Person and Unaffiliated Individual?
These user roles are not relevant anymore Data model design and implementationDione Mentisdione@coko.foundationDione Mentisdione@coko.foundation2020-02-17https://gitlab.coko.foundation/ncbi/ncbi/-/issues/25Workflow: Word-source chapters processed at book-part level2020-03-31T12:00:07ZDione Mentisdione@coko.foundationWorkflow: Word-source chapters processed at book-part levelHi @lathrops1
Attached is the Word-source workflow diagrams for your team to review. Each Step in diagram shows:
```
What the users sees/
What the user does
```
For example:
```
Book manager (Metadata modal)/
1. Add book metadata...Hi @lathrops1
Attached is the Word-source workflow diagrams for your team to review. Each Step in diagram shows:
```
What the users sees/
What the user does
```
For example:
```
Book manager (Metadata modal)/
1. Add book metadata
2. Save
```
At this stage our aim is to confirm that "what the user does" is accurate. Based on your feedback, we will review and update the current wireframes.
The Word doc has questions and comments for your attention. The PDF includes all workflow diagrams.
[Word-source_workflows_for_NCBI_review.docx](/uploads/a1df63ea9e242bbc6fccc34808013d3d/Word-source_workflows_for_NCBI_review.docx)
[SFM__Word-source_workflows-20200306.pdf](/uploads/b1d401f4c87eb8193a07c12558a3b068/SFM__Word-source_workflows-20200306.pdf)Scoping features requirementsStacy LathropStacy Lathrop2020-03-13https://gitlab.coko.foundation/ncbi/ncbi/-/issues/23Document possible types of conversion errors in Word-source workflow2020-11-10T19:01:46ZStacy LathropDocument possible types of conversion errors in Word-source workflowFrom agenda: Clarification on the possible conversion errors in the Word-source workflowFrom agenda: Clarification on the possible conversion errors in the Word-source workflowCreate the book-part recordsDione Mentisdione@coko.foundationDione Mentisdione@coko.foundation2020-03-13https://gitlab.coko.foundation/ncbi/ncbi/-/issues/59Workflow of assigning organisation roles and content roles2021-01-13T19:25:34ZDione Mentisdione@coko.foundationWorkflow of assigning organisation roles and content rolesHi @lathrops1
(cc @John.kopanas, @danjela, @henrik, @yannis)
Based on our discussion in the progress review call about the confusion over 'team' versus 'roles', we have designed these changes to the organisation page. Please review ...Hi @lathrops1
(cc @John.kopanas, @danjela, @henrik, @yannis)
Based on our discussion in the progress review call about the confusion over 'team' versus 'roles', we have designed these changes to the organisation page. Please review this closely with your team.
**Organisation's users page**
An organisation's users now has its own page.
* We've changed the column name from "Team" to "Roles" and combined the admin column since this represents *organisation* roles. The Admin role will be displayed first in this column.
* We've changed the bulk action button from "Team" to "Assign roles"
![ii_k98hep749](/uploads/e4815d517f08437b0fe23bfe0dca79ee/ii_k98hep749.jpg)
**Edit user modal**
* Currently, it isn't possible to open the 'Edit User' modal unless the user has been accepted to the org. As explained in #36, clicking on a user's row will now open the modal, so the System admin can accept a single user and assign the "Org admin" role, and any other roles, at the same time.
* All organisation roles are shown together under the heading "Organisation roles"
![Edit_user](/uploads/e862264b59d57060fd63e832424c767e/Edit_user.jpg)
We considered how to show a user's *content* roles in the table view, but ultimately tying to fit this detail into a table would detract from the purpose of showing an overview. Instead, scrolling down, the Admin will see the user's content roles. This will list all the books and collections that the users has been associated with. The Admin can also go through the user cards to see this detail for each user by using "next" and "previous", instead of having to open and close each one.
![Edit_user_2](/uploads/4188d9accead6c84cd0b60b31c22fe1f/Edit_user_2.jpg)
**Dashboard: New book modal**
The current development of the New book modal demonstrates one purpose of assigning organisation roles on the Admin page. Those users who have been assigned the role "Org admin" and "Editor" see the 'New Book/Collection' button because these roles have the permission to create new books and collections for their organisation.
![ncbi_10](/uploads/7fd736314656443bde37b899b4638cc6/ncbi_10.png)
**Book Manager and Collection Manager**
Once a book or collection has been created, the Org Admin and Editor can assign users to content via the 'Team' modal, individual rows or the bulk actions bar. (We think using the word 'Team' makes sense here as the team working on this book/collection, but please let us know if you disagree).
Content roles can be assigned per book and per chapter. Permissions for books versus chapters should be managed separately in the UI:
* Users assigned via the 'Team' modal have access to the book
* Users assigned via the individual chapter row (modal/card or expand row design TBD) have access to that chapter
* Users assigned via the bulk action bar have access to the selected chapters.
Since users already have *organisation* roles, the list of users to assign to content can be limited by the organisation role.
We have a draft of this design but there are some use cases to work through:
1. As an Editor, I need access to the full book so I can see and edit any chapter, and assign other users to these chapters -- is this always the case, or will some editors only need chapter level access?
2. As an Editor, I want an overview of all the team members working on my book, including whether they have access to the full or individual chapters.
3. As an Author, I need access to the full book so that I can *upload* new chapters and *view* my chapter in context.
4. As an Author, I should only be able to *edit* chapters that I have uploaded or been assigned to by the editor.
5. As an Author, I want to suggest a reviewer for my chapter -- is this applicable?
6. As an Reviewer, I only want to see the chapters that I've been assigned to review. -- is this always the case, or will some reviewers need book level access?
**Team modal**
In this view, the author assigns users to the book, and can see an overview of the full team.
![Team](/uploads/0187f012eeb4e4c8c4953d59841aa3ea/Team.jpg)
**Assign to chapters bulk**
Select rows and 'Assign' button
![assign_chapters](/uploads/5f15b93d6de9b545fa74adcffe8cab4c/assign_chapters.jpg)
Modal shows selected chapters for admin to confirm
![Assign](/uploads/f9668b81fe5c807272bd7b75a9704559/Assign.jpg)
User roles and communicationDione Mentisdione@coko.foundationDione Mentisdione@coko.foundation2020-05-08https://gitlab.coko.foundation/ncbi/ncbi/-/issues/86User is removed from Users table after being rejected2020-06-10T10:53:10ZDione Mentisdione@coko.foundationUser is removed from Users table after being rejectedHi @John.kopanas
As discussed, please can you check this functionality again.
* Current behaviour: User is removed from Users table after being rejected
* Desired behaviour: User shows in table with 'X' status and lighter font after ...Hi @John.kopanas
As discussed, please can you check this functionality again.
* Current behaviour: User is removed from Users table after being rejected
* Desired behaviour: User shows in table with 'X' status and lighter font after being rejected (this was working previously).Giannis Kopanasjkopanas@gmail.comGiannis Kopanasjkopanas@gmail.com2020-06-09https://gitlab.coko.foundation/ncbi/ncbi/-/issues/85Assign roles button shouldn't be active for pending or disabled users2020-06-10T12:55:37ZDione Mentisdione@coko.foundationAssign roles button shouldn't be active for pending or disabled usersHi @John.kopanas and @danjela
Based on feedback in #75 about improving the Workflow of accepting and assigning roles, please make this change:
* [x] When admin bulk selects "pending" users - the "Assign roles" button should not be a...Hi @John.kopanas and @danjela
Based on feedback in #75 about improving the Workflow of accepting and assigning roles, please make this change:
* [x] When admin bulk selects "pending" users - the "Assign roles" button should not be active.
* [x] When admin bulk selects "rejected" users - the "Assign roles" button should not be active.
* [x] When admin bulk selects a combination of "pending" and "disabled " users - the "Assign roles" button should not be active.
* [x] When admin bulk selects a combination of "pending" + "accepted" users or "disabled" + "accepted" users --> "Assign roles" button --> after button action show warning notification: "Accept or enable the user's organization membership before assigning roles."2020-06-09https://gitlab.coko.foundation/ncbi/ncbi/-/issues/84Notification bug on pending users2020-06-10T10:47:52ZDione Mentisdione@coko.foundationNotification bug on pending usersHi @John.kopanas and @danjela
As discussed:
1. Remove this warning when an admin accepts or rejects a pending user
![admin-users-01.mov](/uploads/204b249cb443adafca8ad222ba1c84f8/admin-users-01.mov.png)Hi @John.kopanas and @danjela
As discussed:
1. Remove this warning when an admin accepts or rejects a pending user
![admin-users-01.mov](/uploads/204b249cb443adafca8ad222ba1c84f8/admin-users-01.mov.png)2020-06-09https://gitlab.coko.foundation/ncbi/ncbi/-/issues/81V1 Team modal fixes2021-01-13T19:23:24ZDione Mentisdione@coko.foundationV1 Team modal fixes@John.kopanas and @danjela
From feedback in #75
> I'd suggest that when you click the "x" after a role in the roles dropdown (see below) that you don't remove the member from the group automatically. Instead you let the person using th...@John.kopanas and @danjela
From feedback in #75
> I'd suggest that when you click the "x" after a role in the roles dropdown (see below) that you don't remove the member from the group automatically. Instead you let the person using the modal, choose a new role. If you really do not allow members without roles to remain in the group, then when someone chooses Save, you could pop up a message that says, you have a member(s) without a role, please Remove the member or assign them a role before saving.
I agree with this. The editor may want to remove one role before assigning another role -- this isn't possoble since the user row is deleted when the role is removed.
See screen recording for changes: ![team-modal-20200603](/uploads/2f7338cdf27e4598f61d1de1111c2b6d/team-modal-20200603.mp4)
* [x] Instead of removing the user row when all roles are removed, show validation text "Role required" (Let me know if you have a better suggestion).
* [x] When adding a role to an existing user, the user role should not change. In the video user 'Bo' moves from first row to last row
* [x] Change the button text "Unassign" to "Remove from team".
* [x] The "x" at the end of the dropdown where you select the username in order to add a member does not work to clear the username, instead it pulls up the dropdown menu.User roles and communication2020-06-16https://gitlab.coko.foundation/ncbi/ncbi/-/issues/80V1 Settings modal fixes2020-06-19T09:32:05ZDione Mentisdione@coko.foundationV1 Settings modal fixes@John.kopanas and @danjela
From feedback in #75
* [x] When the toggle "Display PDF for download" is turned off, sub-settings (each chapter or complete book) should also be turned off
* [x] Place the lock icons closer to setting toggl...@John.kopanas and @danjela
From feedback in #75
* [x] When the toggle "Display PDF for download" is turned off, sub-settings (each chapter or complete book) should also be turned off
* [x] Place the lock icons closer to setting toggles, as show in the wireframes
* [x] Users should be able to unlock the locked settings, since we are developing from the Sys Admin POV.2020-06-16https://gitlab.coko.foundation/ncbi/ncbi/-/issues/79Modal closes near 'save' button2020-06-19T09:23:59ZDione Mentisdione@coko.foundationModal closes near 'save' button@John.kopanas and @danjela
From feedback in #75
> A few times I made changes to the book metadata and settings and didn't seem like my changes were saved the first time. e.g. clicked Metadata > made changes & saved > clicked Metadata...@John.kopanas and @danjela
From feedback in #75
> A few times I made changes to the book metadata and settings and didn't seem like my changes were saved the first time. e.g. clicked Metadata > made changes & saved > clicked Metadata again immediately > changes not reflected >made changes again & saved > clicked Metadata again > changes were now ok. ... I saw this a couple of times with new users but could not replicate after
I think I have reproduced this. When you click near the save button the modal closes, so the user thinks she has saved the content, but she hasn't.
See screen recording:
![metadata-modal-20200603](/uploads/46a90634a07eb1c37a7f2ea0981945d3/metadata-modal-20200603.mp4)2020-06-16https://gitlab.coko.foundation/ncbi/ncbi/-/issues/82Design review: Manually order and preview a book's TOC2020-06-10T15:04:02ZDione Mentisdione@coko.foundationDesign review: Manually order and preview a book's TOCHi @lathrops1
Here are the wireframes and description of how users would manually order and preview a book's table of contents for your teams' review.
The book manager lists all the book's components for a particular book. The order ...Hi @lathrops1
Here are the wireframes and description of how users would manually order and preview a book's table of contents for your teams' review.
The book manager lists all the book's components for a particular book. The order of these components is the order of the TOC. Users can manually order these by dragging them into the correct place, as indicated by the drag/move icon.
![NCBI-TOC](/uploads/e85e99c68f7cb4fb87a55c389a4d6b66/NCBI-TOC.jpg)
In the top right of the screen, there is a "Preview TOC" button. Selecting this would open the modal below. The preview shows the current version of all the book components in the Book Manger, irrespective of their status. What's shown here will depend on the settings that the Editor has chosen in the Setting modal (e.g. display 'date created').
![NCBI-TOC-preview-final](/uploads/2d142ac77932922391ef7b3bee97c88a/NCBI-TOC-preview-final.jpg)
This modal can be extended in future iterations if necessary, but for now the aim is to provide a quick way for the Editor to preview the TOC on the fly.
Let me know if there are any questions. I'd like to get this approved in time to start the dev in the next cycle.2020-06-22https://gitlab.coko.foundation/ncbi/ncbi/-/issues/78Design improvement: User modal2020-06-10T14:51:17ZDione Mentisdione@coko.foundationDesign improvement: User modal@John.kopanas and @danjela
From feedback in #75
> When accepting or editing a user in an Org, the modal does not have any indication of what Org you're working in. It would be nice to have the name listed like what is seen in the met...@John.kopanas and @danjela
From feedback in #75
> When accepting or editing a user in an Org, the modal does not have any indication of what Org you're working in. It would be nice to have the name listed like what is seen in the metadata and other modals
Please add the org name to the modal so it reads Organization Name: Edit User
I'll add this to the schedule for next cycle (or complete if you have a gap before then)2020-06-23https://gitlab.coko.foundation/ncbi/ncbi/-/issues/97Add explainer text for bulk upload2020-07-07T08:33:57ZDione Mentisdione@coko.foundationAdd explainer text for bulk upload@danjela here is the explainer text for the bulk upload modal:
Bulk upload only supports uploading one or more Word documents using the Bookshelf Word template and styled according to the specifications provided in the [NCBI Bookshelf ...@danjela here is the explainer text for the bulk upload modal:
Bulk upload only supports uploading one or more Word documents using the Bookshelf Word template and styled according to the specifications provided in the [NCBI Bookshelf Author Guide](https://preview.ncbi.nlm.nih.gov/books/NBK310885/).
Supplementary files must be uploaded directly to the associated chapter.
The document filename is limited to 19 characters. Filenames:
* should only contain letters, numbers, dashes, periods, and underscores
* must not begin with a numeral
* must not contain spaces.
Make sure each document has a unique filename. Duplicate filenames within one book will cause problems in the publishing process.
WARNING! Do not modify the Word document filename for an existing record when you are updating it.
Please note that it can take up to 20 to 30 minutes before a preview is available. Any errors in preparing the preview will be reported before a preview may be generated.Create the book-part recordsDanjela Shehidanjelashehi@gmail.comDanjela Shehidanjelashehi@gmail.com2020-07-02https://gitlab.coko.foundation/ncbi/ncbi/-/issues/99Show all setting in new book modal2020-07-07T08:33:57ZDione Mentisdione@coko.foundationShow all setting in new book modalAs in #87
* [x] Show all TOC settings in the create a book modal (none of these setting are required)
* [x] Add a confrimation message for settings that are locked after book has been created: "Only System Admin can change this setting...As in #87
* [x] Show all TOC settings in the create a book modal (none of these setting are required)
* [x] Add a confrimation message for settings that are locked after book has been created: "Only System Admin can change this setting after the book has been created." @danjela let's discuss what this will look like before implementing please.Set up the book2020-07-03https://gitlab.coko.foundation/ncbi/ncbi/-/issues/98Team modal fixes2020-07-07T08:33:57ZDione Mentisdione@coko.foundationTeam modal fixesAs in feedback from #87
* [x] When a user (Editor) creates a book, this user must be automatically added to book team. I.e. show user listed in the modal.
* [x] Clicking on x on the inside of the role box should remove all **roles**...As in feedback from #87
* [x] When a user (Editor) creates a book, this user must be automatically added to book team. I.e. show user listed in the modal.
* [x] Clicking on x on the inside of the role box should remove all **roles** in the box. It should not remove the user from the team.
* [x] Add delete icon for each row to remove individual user from the team. (This is the same style already used in for deleting authors and editors in the metadata modal).
~~* [ ] Add confrimation message before removing user from team - "Are you sure you want to remove this user from the team?" @danjela Let's disuss what this will look like before you implement it please.~~ 2020-07-03https://gitlab.coko.foundation/ncbi/ncbi/-/issues/96Book component don't show in page after bulk upload2020-07-28T07:58:59ZDione Mentisdione@coko.foundationBook component don't show in page after bulk upload
After Bulk uploading files, sometimes I need to refresh the page before I see the files (NCBI also gave this feedback in #87)
After Bulk uploading files, sometimes I need to refresh the page before I see the files (NCBI also gave this feedback in #87)Create the book-part recordsGiannis Kopanasjkopanas@gmail.comGiannis Kopanasjkopanas@gmail.com2020-07-20https://gitlab.coko.foundation/ncbi/ncbi/-/issues/121Review of V1 release2020-12-04T16:02:22ZDione Mentisdione@coko.foundationReview of V1 releaseHi @lathrops1
cc @John.kopanas and @danjela
V1 is ready for your team to test at: http://ncbi.coko.foundation/
For this testing, since there is no real integration, you'll need to use the files we have identified for V1 -- otherwise...Hi @lathrops1
cc @John.kopanas and @danjela
V1 is ready for your team to test at: http://ncbi.coko.foundation/
For this testing, since there is no real integration, you'll need to use the files we have identified for V1 -- otherwise the metadata cannot be shown in the UI and the file downloads will not work.
![client-work_2](/uploads/8cca2387e453557b4c89ef13f343718b/client-work_2.png)
In this last cycle we have developed:
1. Add book cover (#91)
2. Preview tab for book components, excluding feedback panel
3. manage team tab for individual book components ([docs here](https://gitlab.coko.foundation/ncbi/ncbi/-/wikis/Workflows-and-wireframes/Assign-organisation-and-content-roles))
4. publish book components for the first time ([docs here](https://gitlab.coko.foundation/ncbi/ncbi/-/wikis/Workflows-and-wireframes/Publish-book-components))
5. create BITS xml TOC file (#24)
6. Bug fixes: #95, #96, #104, #105, #109, #110, #111
7. Design improvements: #97, #98, #99, #106, #107, #112
The remaining documentation is listed on the [wiki homepage](https://gitlab.coko.foundation/ncbi/ncbi/-/wikis/home)
If you experience any of the bugs listed above, please report these in the relevant issue. Any other bugs should be reported in separate issues.
Keep in mind that the following feedback from previous rounds has not been implemented. Our team can start on these during your review time.
1. Bulk upload file checks and creating new file versions (#116)
2. Place component in correct section based on xml metadata (#101)
3. Design improvements to date picker in metadata (book and book component) (#117)
Future issues are tag with "Features backlog" in this repo. When providing your feedback it would be helpful to our team to check your feedback doesn't relate to an existing issue before reporting it. All features for the word workflow listed on the [Features board](https://wekan.coko.foundation/b/NwvWuw8Db4nLpFKav/version-1-features).
Please let me know if you need clarification on any of the above.Version 1: features and design improvements2020-07-21https://gitlab.coko.foundation/ncbi/ncbi/-/issues/191Login and register pages Refactor2021-03-26T13:53:59ZDanjela Shehidanjelashehi@gmail.comLogin and register pages RefactorWe need to refactor code in the login and register page before we go on with other features. Here is a list of what i think needs to be changed:
* [x] Use the `TextFieldComponent` for all text fields , in case the current component do...We need to refactor code in the login and register page before we go on with other features. Here is a list of what i think needs to be changed:
* [x] Use the `TextFieldComponent` for all text fields , in case the current component does not fit, improve that component to be adjustable for all cases we use it.
* [x] `RemeberMeCheckbox` is redundant, as we already have on checkbox
* [x] `SubmitButton` is just a normal button, no need for new component
* [x] graphql folder inside Login folder should only contain index.js file with all mutations and queries (as there is no sense separating them when we don't have many queries and mutations)
* [x] Same issues in Register page
* [x] if the Register is working fine we can delete the Signup folder
* [x] Check all styled components in login and register folders to make sure we have used theme variables. ex fixed numbers in pixels should be only inn `gridUnit` * or / a number to where we need it.
Functionality issues :
~~* [ ] If you are in a page and the session has expired , it should redirect to Login page, in this state where the app is, it just hides the menu making it impossible for a normal user to go to login page, the only way is by adding /login to url~~
* [x] Can you try to do remember me functionality (see [this link](http://www.webstudypoint.com/remember-me-functionality-in-react-js/))
* [x] in login page , after you type password, when pressing enter key (from keyboard) should trigger the submit button, it used to work like that before , and it usually does in all apps
@DioneMentis the list of UI components we share in different pages is :
* Form elements
* Toggle, Input fields, Selects, Checkbox, Icon buttons
* Composite Elements
* Status (book component status,book status and file statuses ), Source File Icons, Date component (in human readable format as in dashboard example),Pages Filter, Tabs and Accordions
* App bar, Second navigation bar, Footer Action bar
I think once these ui elements as finished and cover all our cases, we will be just re-using them and won't have conflicts working in different pages, some of them may just need changes in the styles, some may need to be redone as some elements that we use pubsweet may not be extendable enough for our needs2020-09-25https://gitlab.coko.foundation/ncbi/ncbi/-/issues/633Order Books in dashboard by Last Updated2021-08-26T15:19:02ZDanjela Shehidanjelashehi@gmail.comOrder Books in dashboard by Last UpdatedChange default order of books in the dashboard from `by Title `to `by Last Updated`Change default order of books in the dashboard from `by Title `to `by Last Updated`Aug 01.Danjela Shehidanjelashehi@gmail.comDione Mentisdione@coko.foundationDanjela Shehidanjelashehi@gmail.com2021-08-11