Informational UI

Introduction

There are several concepts in Metaport, and states in which various data can be, that requires further explanation if we're to achieve use by non-technical users. One way to do this, is with helpful informational and contextual information presented in the UI.

User Story

As a non-technical user

I'd like to be able to see contextual help in the UI

So that I can find out more about certain Metaport features

Technical

• Look at the Tip class and adding ->setTip($tip) to form-fields
• Content is managed in markdown and links to the relevant page on docs.metaport.sh
• Content is presented in a UI dialogue
• Content is properly modelled
• Content is broken up into x4 components (examples below)
  • Scenario Framework table displays "Unknown"
  • Reason "No Framework was found for this app in the last run"
  • Action "Consult a developer"
  • Info <link_to_metaport_docs>
• Content is found by clicking a generic "i" icon or clicking the informational "lozenges" which Metaport uses.
• Wherever "No Data" messages are shown, they should be contextualised to become e.g. "No Data" <reason>+<report it>
• Custom exception classes is where translated error messages should be declared