[MGNLRES-189] Show meaningful "type" and "format" values for resource files Created: 06/Aug/15  Updated: 29/Mar/22  Resolved: 01/Mar/22

Status: Closed
Project: Magnolia Resources Module
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Story Priority: Neutral
Reporter: Michael Mühlebach Assignee: Unassigned
Resolution: Won't Do Votes: 0
Labels: ux
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File Type and Format columns.png    
Issue Links:
dependency
is depended upon by MGNLRES-191 Visual improvements for the Resource ... Closed
is depended upon by MGNLRES-204 Add icons to indicate different resou... Closed
Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Date of First Response:
Epic Link: 1st set of chgs for Resource files app
Story Points: 8
Team: Nucleus

 Description   

In the Resource files app, the

  • "Type" column denotes the type of resource file. We will differentiate between:
    • "Template" for any type of template
    • "Configuration" for any type of config-by-file resource
    • "Text" for rich and plain text and Word documents
    • "Web resource" for CSS/SASS/HTML/JS and images.
    • "Other" for any other type of file found.
  • "Format" column shows a human-readable version of the file format used by the resource file.
    • We use "YAML", "Freemarker", "Text", "CSS", "Javascript" and the like instead of mere mime-types.

The resource file type connects with the use cases identified for configuring Magnolia (configuration, resources). It will eventually also be used for filtering in a future list view (see also here). It will also be used as a differentiator for instantiating the Resource files app multiple times.

It's probably enough to have a simple algorithm that just takes the file extensions into account. I doubt there's much more needed for a first take.

Note that there's actually a 1:n relationship between "type" and "format" (not 1:1):

  • Template: Freemarker, JSP
  • Configuration: YAML, (Groovy)
  • Web resource: CSS/SASS/LESS, Javascript, HTML, images
  • Text: Text, Rich-text, Word
  • Others: all other type of files not recognized to be among the types above.

Acceptance criteria:

  • human readable values in "type" and "format" columns
  • "type" can act as set for more than one "format" value, which helps to work with resources from different angles (web dev, admin, configuration)


 Comments   
Comment by Jan Haderka [ 17/Sep/15 ]

Where do we read titles/labels for the types? From mime types or from some app specific config?

awedermp Since it was already implemented and rolled back for "looking too ugly" can you please attach mockups of how this should look like to look good?

Comment by Andreas Weder [ 18/Sep/15 ]

Attached link to the document describing the Resource files app. Mockups and descriptions are up-to-date.

Comment by Andreas Weder [ 28/Sep/15 ]

I've attached a mockup showing values in "Type" and "Format" column.

Note this actually shows a list view, which we're currently not offering. I decided to upload this mockup as this example demonstrates many type/format combinations.

Generated at Mon Feb 12 06:48:16 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.