Uploaded image for project: 'MusicBrainz Server'
  1. MusicBrainz Server
  2. MBS-12935

Beta: Type's documentation is no longer accessible from relationship editor

      Two-fold regression about relationship type's documentation when editing a relationship in beta:

      1. The type's description is now only visible in the relationship type selector. You have to deselect the type to be able to read it, and it's displayed in grey only.
        In the main server, it can be toggled through an "help" link and is more readable.
      2. The type's full documentation is no longer linked at all.
        In the main server, it is linked from the end of the type's description toggled by the "help" link.

      See attached screenshots.

          [MBS-12935] Beta: Type's documentation is no longer accessible from relationship editor

          Aerozol added a comment - - edited

          Thanks yvanzo, looks good!

          I will look at fancy help function/toggles in the MB redesign, which will centralise everything into the design-system before being applied site-wide (ideally). I left your note re. not being sure which is on/off.

          But while we're on the topic, maybe I'll use similar toggles to the current LB redesign mockup:

          Aerozol added a comment - - edited Thanks yvanzo, looks good! I will look at fancy help function/toggles in the MB redesign , which will centralise everything into the design-system before being applied site-wide (ideally). I left your note re. not being sure which is on/off. But while we're on the topic, maybe I'll use similar toggles to the current LB redesign mockup:

          yvanzo added a comment -

          After a comment by bitmap to the pull request, and a discussion on IRC #metabrainz with aerozol resulting in his above mock-up, here is an overview for the placement of the new “(help)” toggle link (already used in the tracklist editor for example) as a first implementation. It solves the tab-navigation issue (by placing this link ahead of the first-focused field), requires only one click to show help for both relationship type and attributes which go together anyway.

          The fancy CSS toggle switch would be nice to have later on. I’m not sure which one represents the position on though. Maybe it should make it to the design-system repository at first?

          yvanzo added a comment - After a comment by bitmap to the pull request, and a discussion on IRC #metabrainz with aerozol resulting in his above mock-up, here is an overview for the placement of the new “(help)” toggle link (already used in the tracklist editor for example) as a first implementation. It solves the tab-navigation issue (by placing this link ahead of the first-focused field), requires only one click to show help for both relationship type and attributes which go together anyway. The fancy CSS toggle switch would be nice to have later on. I’m not sure which one represents the position on though. Maybe it should make it to the design-system repository at first?

          Aerozol added a comment - - edited

          How I would imagine doing it in the redesign style, using your suggestion of having a toggle at the top:

          Edit: Just a quickie, not sure about the blue colour (but could work to have a new colour for all help/doc related buttons and items)

          Aerozol added a comment - - edited How I would imagine doing it in the redesign style, using your suggestion of having a toggle at the top: Edit: Just a quickie, not sure about the blue colour (but could work to have a new colour for all help/doc related buttons and items)

          Aerozol added a comment -

          Trying to address the issue of one [?] box being a tooltip and one making multiple help boxes appear, how about having two types of icons?

          Putting the help box to one side may also help with clutter and allow us to add it to other MB pages.

          (below has a white dotted outline for the tooltip/mouse-over help button)

           

           

          We can make them stand out if wanted:

          Aerozol added a comment - Trying to address the issue of one [?] box being a tooltip and one making multiple help boxes appear, how about having two types of icons? Putting the help box to one side may also help with clutter and allow us to add it to other MB pages. (below has a white dotted outline for the tooltip/mouse-over help button)     We can make them stand out if wanted:

          Aerozol added a comment -

          Looks good yvanzo - what about having the [?] box instead of the (help) text?

          Aerozol added a comment - Looks good yvanzo - what about having the [?] box instead of the (help) text?

          yvanzo added a comment -

          aerozol, a few reasons not to:
          1. The style you mention only applies to fields in half-width column where there is guaranteed free place on the right. Implementing it for the relationship dialog popover wouldn’t be straightforward and would certainly come with some more issues that would further delay the next release.
          2. In the longer term, the half-width layout might have to be abandoned anyway to allow supporting mobile devices which have smaller screens.


          Attached is an overview of the help toggle link/description for relationship type I implemented, it follows the same style as the help toggle link/description for relationship attributes below. It allows to keep viewing the type’s description while editing attributes.

          yvanzo added a comment - aerozol , a few reasons not to: 1. The style you mention only applies to fields in half-width column where there is guaranteed free place on the right. Implementing it for the relationship dialog popover wouldn’t be straightforward and would certainly come with some more issues that would further delay the next release. 2. In the longer term, the half-width layout might have to be abandoned anyway to allow supporting mobile devices which have smaller screens. Attached is an overview of the help toggle link/description for relationship type I implemented, it follows the same style as the help toggle link/description for relationship attributes below. It allows to keep viewing the type’s description while editing attributes.

          Aerozol added a comment -

          What about using the same on-click style we use for 'add artist' elements?

          Keeps the interface a bit clearer.

          Standardizing all the help/doc UX (and making it appealing/easy) is a big goal, another one on my to-do list...

          Aerozol added a comment - What about using the same on-click style we use for 'add artist' elements? Keeps the interface a bit clearer. Standardizing all the help/doc UX (and making it appealing/easy) is a big goal, another one on my to-do list...

          yvanzo added a comment -

          Additionally an help link to the corresponding tree documentation page such as “Artist-Work relationship types” is added when no relationship type is selected.

          yvanzo added a comment - Additionally an help link to the corresponding tree documentation page such as “ Artist-Work relationship types ” is added when no relationship type is selected.

          GitHub Bot added a comment -

          See code changes in pull request #2866 submitted by yvanzo.

          GitHub Bot added a comment - See code changes in pull request #2866 submitted by yvanzo .

            yvanzo yvanzo
            yvanzo yvanzo
            Votes:
            1 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:

                Version Package
                Beta