okp4 / dataverse-portal

🔭 Dataverse Portal for the OKP4 network.
BSD 3-Clause "New" or "Revised" License
8 stars 1 forks source link

[Governance] - main sections #105

Open Gab-pm opened 1 year ago

Gab-pm commented 1 year ago

Feature: Data Space governance - main sections

As a user of the Data Space, I want to see all the sections of the governance rules, So that I understand the terms and conditions of the Data Space

Acceptance criteria

Scenario 1: Default display (desktop)

Given that I am a user of the web portal (unauthenticated or authenticated), And I am using a desktop device, When I am on the Data Space Governance page Then I should see the title of the Data Space And I should see the different section titles that appear as presented in the mockup below new And the first section (and its first subsection if available) is selected and displayed on the right hand side following scenario 3

Scenario 2: Mobile Display

Given that I am a user of the web portal (authenticated or unauthenticated), When I am on the Data Space governance page And I use a mobile device Then I should see mobile friendly display (See mock up)

Scenario 3: Selected section

Given that I am a user of the web portal (authenticated or unauthenticated), And I am on the Data Space governance page edited When a section (or subsection if available) is selected Then the selected section should be displayed with its title (See mock up) new And if available the title of the subsection as a subtitle

Scenario 4: Section WITH subsection

new Given that I am a user of the web portal (authenticated or unauthenticated), And I am on the Data Space governance page When I select a section having subsections Then the subsections are displayed on the sidebar following the tree hierarchy And all those subsections are related to the section with a thin line (see mockup) And by default the first subsection is selected to be displayed on the right hand side of the page following scenario 3

Scenario 5: Section WITHOUT subsection

new Given that I am a user of the web portal (authenticated or unauthenticated), And I am on the Data Space governance page When I select a section that doesn't have any sub-section Then the section is displayed on the right hand side of the page following the scenario 3

Scenario 6: Ordering section and subsection

new Given that I am a user of the web portal (authenticated or unauthenticated), And I am on the Data Space governance page Then I see that the sections (and subsections if available for a section) are ordered following the order of the numbers defined for the item in the ontology For more detail about ordering items please read this PR : https://github.com/okp4/ontology/pull/108

Scenario 7: Routing

new Given that I am a user of the web portal (authenticated or unauthenticated), When I use the browser search bar and enter ..dataspace/id/gouvernance Then I should land on the URL of the first section (and first subsection if available) of the dataspace's gouvernance I entered in the initial URL

Scenario 8: Internationalization

Given that I am a user of the web portal (authenticated or unauthenticated), When the selected language is English, French, or German Then sections title should be displayed in the adequate selected language

Config example

En edited

Governance

Identity Management

Governance Model

  • Create rules
  • Edit rules
  • Remove rules

Datasets Management

  • Reference dataset
  • Create metadata
  • Edit metadata
  • Remove metadata
  • Dereference dataset
  • Download dataset

Services Management

  • Reference service
  • Create service metadata
  • Edit service metadata
  • Remove service metadata
  • Dereference service

Business Model

  • Dataset retribution
  • Service retribution

Fr edited

Gouvernance

Gestion des Identités

Modèle de Gouvernance

  • Créer des règles
  • Mettre à jour les règles
  • Supprimer des règles

Gestion des Jeux de Données

  • Référencement du jeu données
  • Créer des métadonnées
  • Supprimer des métadonnées
  • Déréférencer le jeu de données
  • Télécharger le jeu de données

Gestion des Services

  • Référencement du jeu de données
  • Créer des métadonnées
  • Supprimer les métadonnées
  • Déréférencer le jeu de données

Modèle Économique

  • Rétribution du jeu des données
  • Rétribution des services

Gr edited

Governance

Verwaltung von Identitäten

Modell der Governance

Verwaltung von Datensätzen

  • Referenzdatensatz
  • Metadaten erstellen
  • Metadaten löschen
  • Dataset dereferenzieren
  • Datensatz herunterladen

Verwaltung von Dienstleistungen

  • Referenzdatensatz
  • Metadaten erstellen
  • Metadaten löschen
  • Dataset dereferenzieren

Wirtschaftliches Modell

  • Dataset-Retribution
  • Dienstvergütung

Requirements

  1. Default landing section is Identity Management

Resources

Mockups

Desktop

image.png

Mobile

image.png

Environment

Additional informations

None.

┆Issue is synchronized with this Wrike task by Unito

lolottetheclash commented 1 year ago

@MdechampG regarding the url, is it /dataverse/dataspace/ID/governance?

MdechampG commented 1 year ago

I have written in my notes (in November) /governance/ID As it is not directly to the description of a Data Space, it is not necessary to put it in the dataverse. What do you think @ccamel ?

MdechampG commented 1 year ago

@ccamel @fredericvilcot could we discuss it today ?

ccamel commented 1 year ago

Sure @MdechampG.

lolottetheclash commented 1 year ago

@MdechampG should we consider implementing some subroutes when clicking on a section (like: datasets management)? And what about the root url, the route: /dataverse/dataspace/ID/governanceis implemented for now, should we change it to /governance/ID ?

ccamel commented 1 year ago

@lolottetheclash IMHO, sections should be reflected in the route in some way. The rule is simple. If I relocate the page, I must find the same context.

For the final scheme of the routes, it'd be great to make a point together.

loiclaudet commented 1 year ago

@SpicySalm0n the title is composed of the label of the data space element (rhizome on the mockup), separated from the word governance by a | pipe.

Screenshot example for mobile version

image

What happens when the label contains several words and much more characters? Is it truncated? If yes, what is it's maximum length? Can the pipe be positioned at the beginning or a end of a line ?

Thanks

SpicySalm0n commented 1 year ago

@0xLodz the best is to switch on 2 lines, the user can arrive from a web link, it's preferable that the name of the data space is displayed in full. The pipe can be at the end or the beginning of the line, no word can be truncated.

To be confirmed with @MdechampG but the number of characters to define the title of a data space must be limited to a certain number of characters to maintain good ergonomics throughout the portal (explorer cards, detail pages) and avoid lengthy titles.

Capture d’écran 2023-04-12 à 13 23 41 Capture d’écran 2023-04-12 à 13 26 03
MdechampG commented 1 year ago

Decision about the URL of the page : /dataverse/dataspace/ID/governance

lolottetheclash commented 1 year ago

According to the discussion with @ccamel , it was decided that when a user chooses a section as well as a sub-section, the url will carry these indications to be shared correctly, like: /dataverse/dataspace/ID/governance/Section1/SubSection1 Section1 & SubSection1 are both elements ids, like:

ex:Section1 a meta:Section, owl:NamedIndividual ;
  core:hasTitle "Datasets Management" ;
  core:hasDescription "Specifies the governance rules regarding the management of datasets." ;
  meta:hasNumber "1.1" ;
  core:isPartOf ex:Chapter1 .

Do you agree @MdechampG ?

MdechampG commented 1 year ago

Yes it's ok for me thanks

ccamel commented 1 year ago

To summarize:

/dataverse/dataspace/<id>/governance/<id>/<id>

                      │                │   │
                      │                │   └── Identifier of the sub-section in the governance
                      │                └── Identifier of the section in the governance
                      └── Identifier of the dataspace
loiclaudet commented 1 year ago

The ID in the URL scheme allow us to find the right dataspace item. Is it possible that no dataspace item are found for this ID? If yes, what should we display to the user?

loiclaudet commented 1 year ago

@SpicySalm0n no back button are displayed on mobile. Is it what we want?

SpicySalm0n commented 1 year ago

@0xLodz I considered that on mobile, native web applications all had a native back button at the bottom of the page (mobile navigation is done mainly on the lower part of the screen with the thumb). There is also native scroll back on mobile (Safari, Chrome...). So I made the choice to leave the back button to the native application. Same choice on tablet. What do you think?

lolottetheclash commented 1 year ago

The ID in the URL scheme allow us to find the right dataspace item. Is it possible that no dataspace item are found for this ID? If yes, what should we display to the user?

We'll display a 404 page if resource is not found. There is an issue created for this :)

loiclaudet commented 1 year ago

@SpicySalm0n Yes that's totally makes sense. I was wondering that because there is a back arrow button for the mobile Explore page. We might harmonise both page? What do you think? Thanks

SpicySalm0n commented 1 year ago

@SpicySalm0n Yes that's totally makes sense. I was wondering that because there is a back arrow button for the mobile Explore page. We might harmonise both page? What do you think? Thanks

for the catalog detail pages it's a little more complex since the user can arrive from an external link to the portal but the back arrow button brings the user to the Dataverse (Explore). The goal being to encourage him to navigate in the dataverse. On the other hand, if he's coming from his external link, and he uses the native back button of his app, he will return to his web search or the place from which he clicked on the external link... That's why the explorer back arrow button have the "dataverse" wording added I don't think we should remove it for this particular case

To make the difference with the governance for which one can also come from an external link, here one doesn't try to send it back to a particular place of the portal. For the catalog it is a purely incentive back button

loiclaudet commented 1 year ago

@SpicySalm0n @MdechampG what to do when section or subsection texts are very large? Thanks.

image
ChaimaaZaoui commented 1 year ago

@0xLodz I edited the english text in internationalisation

loiclaudet commented 1 year ago

@ChaimaaZaoui on the screenshot I changed the section title for testing. I added all mocked data you provided in this file.

Could we have new sections and subsections in the future that are larger than the one already provided? Thanks

ChaimaaZaoui commented 1 year ago

@0xLodz for now the length of text is not limited, but this is something we are going to work on when defining "create data space" module

MdechampG commented 1 year ago

You're right @ChaimaaZaoui but even if we restrain the number of characters in the UI "Create a Data Space", it will be possible (through other interfaces than the portal) to have long titles. I suggest to have an ellipse. @SpicySalm0n what should be the maximum size that we display ?

SpicySalm0n commented 1 year ago

For the Section and Subsection titles we could put an ellipse with one line or two lines, both are ok for me:

Sections:

One line:

Capture d’écran 2023-04-19 à 11 58 34

Two lines:

Capture d’écran 2023-04-19 à 11 57 30

Subsections:

One line:

Capture d’écran 2023-04-19 à 11 46 50

Two lines:

Capture d’écran 2023-04-19 à 11 54 23
SpicySalm0n commented 1 year ago

in any case the text must not exceed the width of the 3 columns of the layout

loiclaudet commented 1 year ago

I implemented the one line solution. Don't hesitate to ask for changes if necessary. Thanks

ChaimaaZaoui commented 1 year ago

Test executed in firefox