7 | 1.7.1 | & 1.7.2 Re Architecture Efforts

[sync-by-unito]

references:

• Backlog Grooming Board

Included

7 | 1.7.1 | Research & architecture for separating backend and frontend to enable a flexible, scalable design & development of UI modules | 5

7 | 1.7.2 | Implementation of UI modules to improve the dataset landing page and access to remote data | 5#9037

---

Monthly updates below.

---

┆Issue is synchronized with this Smartsheet row by Unito

[mreekie]

This issue represents a deliverable funded by the NIH
This deliverable supports the NIH Initiative to Improve Access to NIH-funded Data

Aim 7: Improve the user experience and interface (UX&UI) and Application Programming Interfaces (APIs) for depositing, viewing, and accessing datasets in the repository to facilitate its use and modularity

To expand the use of generalist repositories among NIH-funded researchers, repositories must be easy to use, meet applicable WCAG 2.1 Level AA accessibility standards adopted by Harvard University, and keep the complexity and best practices of a FAIR repository. Understanding what users expect and designing the interface to be clear for all are keys to make wide adoption successful. We propose to improve three areas of the repository UI: 1) facilitate discovery and exploration of data by making it easier to customize collections of datasets, identify types of data more clearly, expand and improve tools to explore data within repositories, 2) expand and clarify the dataset creation and publishing workflow to make it easier to add a wider variety of data with appropriate metadata, 3) extend the RESTful APIs in the Dataverse software to enable more easily separating the backend web services that support the core Dataverse functionality with the frontend, and build scalable and flexible open-source UI modules for the Harvard Dataverse repository, usable by other repositories. All UX&UI enhancements will include conducting automated and human reviews for accessibility compliance, product research, and user testing.

---

This issue represents a deliverable funded by the NIH
This deliverable supports the NIH Initiative to Improve Access to NIH-funded Data

Aim 7: Improve the user experience and interface (UX&UI) and Application Programming Interfaces (APIs) for depositing, viewing, and accessing datasets in the repository to facilitate its use and modularity

To expand the use of generalist repositories among NIH-funded researchers, repositories must be easy to use, meet applicable WCAG 2.1 Level AA accessibility standards adopted by Harvard University, and keep the complexity and best practices of a FAIR repository. Understanding what users expect and designing the interface to be clear for all are keys to make wide adoption successful. We propose to improve three areas of the repository UI: 1) facilitate discovery and exploration of data by making it easier to customize collections of datasets, identify types of data more clearly, expand and improve tools to explore data within repositories, 2) expand and clarify the dataset creation and publishing workflow to make it easier to add a wider variety of data with appropriate metadata, 3) extend the RESTful APIs in the Dataverse software to enable more easily separating the backend web services that support the core Dataverse functionality with the frontend, and build scalable and flexible open-source UI modules for the Harvard Dataverse repository, usable by other repositories. All UX&UI enhancements will include conducting automated and human reviews for accessibility compliance, product research, and user testing.

[mreekie]

Who:
pdurbin
ekraffmiller
rtreacy
landreev
sekmiller
scolapasta
qqmyers
mreekie

[mreekie]

Updated: Thu Oct 6 2022

The initial meetings have been held internally. The re-architecture effort will be lead by Bob. He and a small subset of the team are working on a straw man architecture document now.

(1.7.1) The first version of White paper has been finished and submitted to the Dataverse open source community and feedback has been collected. Conversations have intensified and team activity has shifted towards the re-architecture of the front-end functionality, and a team has been formed that will include architects from the Harvard Dataverse team, the Dataverse community, and our contractor, Agile Monkeys. The current focus of conversation is around normalization of APIs between the front-end and back-end that will enable alternative UI solutions to be deployed, and the cost estimation for implementing an alternative UI solution for the dataset landing page. A white paper is in development describing the areas of the architecture that need to be addressed and proposed solutions.

[mreekie]

Updated: November 2022

The first version of White paper has been finished and submitted to the Dataverse open source community and feedback has been collected and incorporated. Conversations have intensified. Working groups have been established around Authentication/Authorization, and UI Modularity. Our contractor Agile Monkeys have helped to create a proof of concept to test preliminary ideas that are needed for the re-architecture effort. The white paper describing the areas of the architecture that need to be addressed and proposed solutions continues to be created.

37%

[mreekie]

We are not tracking activity on this yet via sprints
The output of the working groups will be spikes and other types of issues that will be worked in sprints.

[mreekie]

Last updated: Thu Dec 15 2022 before I left for the holiday. Lots of activity, but nothing different to report from last month.
Report: Dec 2022

The first version of White paper has been finished and submitted to the Dataverse open source community and feedback has been collected and incorporated. Conversations have intensified. Working groups have been established around Authentication/Authorization, and UI Modularity. Our contractor Agile Monkeys have helped to create a proof of concept to test preliminary ideas that are needed for the re-architecture effort. The white paper describing the areas of the architecture that need to be addressed and proposed solutions continues to be created.

[mreekie]

monthly update:

• January
  (1.7.1, 17.2) The Authentication/Authorization, and UI Modularity working groups are meeting regularly. The Authentication/Authorization team has met with invested community members, Prototype work continues. Both groups have draft proposals and are close to releasing for the wider community to review.

[mreekie]

Combined IQSS/dataverse#9037 into this deliverable to reflect how we report on them.

[cmbz]

2024/01/03: Closing, work will be tracked here: #123