OpenConceptLab / ocl_issues

Issues for all OCL repos. NOTE: Install ZenHub Browser Extension and request access to the OCL Roadmap board to view all issues and to contribute
4 stars 2 forks source link

Repository design #1935

Closed paulsonder closed 1 month ago

paulsonder commented 2 months ago

Introduction

The visual architecture of the Repository layout and design in V3 aims to give users efficient access to the information they need most as well as visually distinctive patterns to represent owner information, metadata, content, versions, expansions and summaries.

The layout is designed to include the maximum amount of content a user may need to see when viewing a FHIR resource (part of OCL's drive to introduce new 'repo types' such as CodeSystems, ValueSets and ConceptMaps alongside the legacy 'Sources' and Collections'), meaning new thinking for attributes that V2 did not intuitively expose

Header

The header patterns allows a user to identify the Repo's Code, Type, Version, Name and Owner. A number of CTA's allow them to change the version, navigate to the owners Organization page and Follow, Export or Share the Repository. For users with Edit permissions, the menu on the top right of the header includes CTA's to manage the Repository.

Screenshot 2024-10-01 at 15 42 23

Summary panel

To the right of the main content area in the template the user can find the Summary panel. It currently consists of three sections:

Chips: This panel includes chips to indicate attributes such as visibility, if the Repo is FHIR ready or it's content flagged as Experimental.

Summary: The Repository summary is below, which brings the V2 summary up front in the UI and could be extended to include counts of new Repository attributes, such as 'Custom Attributes'. Each attribute in the Summary may have additional information to be displayed using the Extended Tooltip component.

Contributors: The Repository contributors are listed below, visualised using their avatars, which are clickable and lead to their User profile page.

Screenshot 2024-10-01 at 15 44 17

Overview

The primary content area of the Repository template is a tabbed view of the Repositories content, including the metadata and content itself (Concepts, Mappings, References).

The Overview serves to house the Repositories metadata and some content from the OCL 'legacy' repo's, such as About. If a particular attribute is not mandatory and has not been added by the author, 'Approval date', for example, then it will not be included in this section.

This section was modelled on the metadata attributes of a FHIR resource. The groupings in the page have been created by the OCL team. These are: Descriptions and Use, Publisher and contact and Reviews and approvals.

Screenshot 2024-10-01 at 15 46 35

Content

The content of the Repository is organized into tabbed sections. These may change depending on the Repository Type. The tabs display content in tabular or card views. Tabs include:

Concepts: Both tables and cards can be filtered. The tabular display allows for a Hierarchical layout.

Screenshot 2024-10-01 at 16 18 35

Expansions: You will notice that the Expansion picker is positioned closer to the content in the layout hierarchy. This proximity implies the relationship with the content and less the Repositories metadata and other versions. I'm interested to know what you think about this.

Mappings: The revised tabular view of mappings uses the 'Group by' design that emerged as a useful mode of understanding Mappings.

Screenshot 2024-10-02 at 10 50 16

References: When a user views a Collection, they should be able to understand the composition of the Repositories content, even if it has not been expanded. Here we utilise a 'Grouped by' view, organised as default 'By source'.

Screenshot 2024-10-02 at 11 07 57

Versions

The current method of navigating versions in V3 is via the Versions menu accessible in the header. This list enables a user to understand some high level information and is the entry point into the Comparison tool. The position in the page hierarchy is intentional and designed so that the user is aware that all data may change below it, should a different version be selected.

Screenshot 2024-10-02 at 11 16 16

Question: Is there a need for a more detailed 'list'? If so, could we capture the user stories below?

Full screens for all the design above can be found here.

jamlung-ri commented 2 months ago

Overall I am feeling pretty good about this. I had some comments in my review of this earlier today, and I've divided them up by person:

For @paynejd and @jamlung-ri :

For @paulsonder :

For @snyaggarwal :

snyaggarwal commented 1 month ago

@paulsonder In the grouped by results of mappings, how will the pagination work?

paulsonder commented 1 month ago

@paulsonder In the grouped by results of mappings, how will the pagination work?

Hi Sunny. Given the nature of the datasets we display, the intention with our data tables in V3 is that they utilise 'infinite scroll / virtual scroll'. This feels more intuitive for hierarchical and grouped by lists.