Your platform will be unavailable on the 13th of November 2024 from 9am to 12pm (Paris time) for maintenance operations

    •  
      epic #37574 New Artifact Links in Artifact View
    Summary
    New Artifact Links in Artifact View
    Trackers

    Overview

    The goal is to port the behavior of "Links" field that is currently implemented in Artifact Modal in the Artifact View.

    There is a big subject around backward compatibility because while new users will welcome the alignement of the behavior, legacy users have developed habits with legacy implementation.

    The proposed way to deal with that is:

    • Display of New Artifact Links is an option of the field, enabled for all new trackers but existing one will remain untouched.
    • The current view (table / report) will be accessible in a dedicated tab (like "Children").

    Links tab

    The Links tab is always displayed (regardless if there is an artifact link field or not, regardless is the "new artifact links" option is activated or not).

    It displays the Forward Links and Reverse links with the breakdown by type and tracker (current display of Artifact Links field).

    It's a pure view, there is no interaction possible (no add, no delete).

    2679-Artifact%20links%281%29.png

    Note: the proposed rendering in the mock-up is with Burning Parrot theme, however it's not mandatory at implementation time. If it's possible with little cost to have BP rendering, let's do it. However we should not spend 2 weeks on that.

    New Artifact Links display

    When the option is activated, The new Artifact Links block is displayed using the new rendering.

    2678-Artifact%20links.png

    The display of the links is the same as in Artifact Modal, it means that it's in Read/Write (unlike the other fields that must be toggled for write). The reason for this choice is:

    • We don't have the pure read view of the new "widget", it's better to have it in Read/Write rather than spending too much time in mock-up & implementation of a pure read
    • The current "read only" view of Artifact View was introduced in Tuleap 7 (gosh) in order to have a prettier view of the Artifact and to leverage the features (colors, links in rich text, etc). The new artifact link widget was built from the ground up to be pretty in R/W view, this lower the need for a pure read view.
    • As its a new, dedicated area, it's not mandatory to follow the UX pattern of other fields.

    The artifact link widget must detect the modification to propose the "Save" automatically and warn users that would want to navigate away after a change.

    All mockups in figma.

    XML import/export & duplication

    The option to toggle the usage of new display must be added in XML import/export mechanism as well as in the SQL tracker duplication.

    Update of templates

    With the new rendering of the field, it might not fit in the current structure of the templates shipped by default. We should check that all trackers:

    • Have the link field enabled
    • The Link field is in a "References" fieldset, at the end of the artifact page, just before the follow-up comments that contains
      • Artifact link field named "Links"
      • Cross references field named "References"
    Progress
    Empty
    Empty
    Empty
    Details
    #37574
    Manuel Vacelet (vaceletm)
    2024-09-26 11:02
    2024-04-12 14:40
    Attachments
    References

    Follow-ups

    User avatar
    • Start date changed from 2024-04-29 to 2024-09-16
    • End date changed from 2024-07-17 to 2024-12-04
    User avatar
    • Description
      Something went wrong, the follow up content couldn't be loaded
      Only formatting have been changed, you should switch to markup to see the changes
    User avatar
    • Description
      Something went wrong, the follow up content couldn't be loaded
      Only formatting have been changed, you should switch to markup to see the changes
    User avatar
    • Description
      Something went wrong, the follow up content couldn't be loaded
      Only formatting have been changed, you should switch to markup to see the changes
    User avatar
    • Description
      Something went wrong, the follow up content couldn't be loaded
      Only formatting have been changed, you should switch to markup to see the changes
    User avatar

    ACs were changed to remove the notion of "Artifact Links always displayed at the end of Artifact, not controlled by artifact field layout".

    The main reasons to wind back on this:

    • Artifact Links is a field, by treating it with a special behaviour (not really a field under some circumstances on Artifact View but as a field everywhere else like reports) we will shoot ourselves in the feet and it will make the code unnecessary complex.
    • If we change the behaviour for Artifact View, we have to change it for Artifact Modal too, it will add yet another bunch of modifications that will bring little value at this stage.
    • It's not perfectly clear that the original proposal (AL always displayed at the end) brings that much value

    The main reason was that, as of today, the AL field can be placed inside a 5th column, itself in a fieldset, etc and that we can predict how the new rendering will behave in situation like that. The tradeoff is to keep the rendering "as it is" and if cumbersome layout doesn't allow to have a fully usable AL field, the tracker admins will have to update their structure or keep using the legacy view.


    User avatar
    • Start date changed from 2024-04-01 to 2024-04-29
    • End date changed from 2024-06-19 to 2024-07-17
    User avatar
    • Description
      Something went wrong, the follow up content couldn't be loaded
      Only formatting have been changed, you should switch to markup to see the changes
    User avatar
    • Description
      Something went wrong, the follow up content couldn't be loaded
      Only formatting have been changed, you should switch to markup to see the changes