AssurancePlatform icon indicating copy to clipboard operation
AssurancePlatform copied to clipboard

[User Story]: Open an assurance case in read-only mode

Open cptanalatriste opened this issue 1 year ago • 9 comments

Role

As an assurance case builder

Desired Feature

I want to be able to view assurance cases shared with me, in read-only mode

Benefit

So that I can work collaboratively on the development or review of an assurance case.

Acceptance Criteria

GIVEN that another user has shared an assurance case with me, in read-only mode WHEN I access this case, from the "Shared with me" section THEN I cannot edit the description of any element AND I cannot add or remove new elements AND I cannot move, attach, re-attach elements AND I cannot export the case to JSON.

Dependencies

No response

Technical Notes

NA

Definition of Done

  • [ ] The feature fulfills all acceptance criteria.
  • [ ] The code is reviewed and meets team coding standards.
  • [ ] All unit, integration, and end-to-end tests are passed.
  • [ ] The feature meets accessibility standards set for the project.
  • [ ] The code passes the CI/CD pipeline quality controls (style and linting).
  • [ ] The feature is merged into the main branch.
  • [ ] The feature is deployed and functional in the QA environment.
  • [ ] The feature was demonstrated to the team and accepted by the product owner.

cptanalatriste avatar Aug 09 '24 15:08 cptanalatriste

@chrisdburr , please have a look, and check if this is the feature you requested.

cptanalatriste avatar Aug 09 '24 15:08 cptanalatriste

Perhaps it would be helpful to agree on more fine-grained roles and permissions:

Role Share Assurance Case Manage Assurance Case (e.g. rename/delete) Edit Assurance Case (e.g. add/edit elements or branches) Add Comments Download View Assurance Case
Owner x x x x x x
Editor x x x x
Reviewer x x x
Viewer x

This would allow us to be more specific with our user stories.

chrisdburr avatar Aug 12 '24 15:08 chrisdburr

So, then, for this particular user story, we could just focus on the assurance case viewer.

chrisdburr avatar Aug 12 '24 15:08 chrisdburr

@chrisdburr , we have the Editor role defined in this user story (review pending) : https://github.com/alan-turing-institute/AssurancePlatform/issues/566

We have not covered the reviewer role yet, maybe you can create a user story?

cptanalatriste avatar Aug 13 '24 07:08 cptanalatriste

I think I have covered most things here for the Read Only view of an Assurance Case Shared with me.

https://github.com/user-attachments/assets/319afc4d-c9d8-4429-ba09-f507ac6717cb

Just waiting on permissions property to be passed down when fetching cases - so we can handle the delete button when hovering over the card.

@chrisdburr @cptanalatriste can you please both review, thanks.

Fyi not in staging as waiting on the property above.

RichGriff avatar Aug 18 '24 19:08 RichGriff

Looks good, @RichGriff. Please could I request a small banner that states the user is in read-only mode?

Not sure whether it should be in the sidebar or the main case window. Happy to leave this design choice to you based on what you think is best.

chrisdburr avatar Aug 19 '24 08:08 chrisdburr

@chrisdburr I dont think a banner is a good idea as it may get in the way and distract the user from other elements.

I have instead decided to so a lock icon next to fields in forms to indicate that this is read only. Making the form field disabled would have greyed out the text and i thought that wasnt ideal either.

Image

With the limited options on screen and these 'locked' fields should be enough for a user to know they are in read only mode, without explicitly spelling it out for them.

RichGriff avatar Aug 19 '24 16:08 RichGriff

@chrisdburr @cptanalatriste this is now in staging

RichGriff avatar Aug 19 '24 17:08 RichGriff

@chrisdburr I dont think a banner is a good idea as it may get in the way and distract the user from other elements.

I have instead decided to so a lock icon next to fields in forms to indicate that this is read only. Making the form field disabled would have greyed out the text and i thought that wasnt ideal either.

Image

With the limited options on screen and these 'locked' fields should be enough for a user to know they are in read only mode, without explicitly spelling it out for them.

This makes sense. Could we add a simple alt-text option to the lock though to explicitly state 'Read-only'? Just to really make clear that it's not a lock that can be unlocked.

chrisdburr avatar Aug 20 '24 10:08 chrisdburr

Closing issue. Feature verified in staging.

chrisdburr avatar Sep 05 '24 13:09 chrisdburr