Uploaded image for project: 'Artifactory Binary Repository'
  1. Artifactory Binary Repository
  2. RTFACT-26389

Customer Defined Documentation



    • Location:


      As a Senior Software Engineer supporting other developers,
      I want the Artifactory UI to support customer-defined documentation,
      So that we can tailor Artifactory to improve our developer experience


      In Artifactory a nice feature is that for repositories the admin user can create a Public Description for users and an Internal Description for admins.

      1. One pain point is that only admins can update these fields. It would be better if a user could be assigned a documentation role or privilege so that they don't need admin access to document resources.
      2. The major pain point is that Artifactory documentation is not very good, it is too complex, too generic, and results in a lot of TL;DR
      3. It would be nice to have more UI elements that can be linked with external, customer documentation. This would allow an organization more ability to tailor the UI to the context of their users, improving the developer experience for their developers.

      UI Design

      Back in the 90s I created and taught a 3rd-year university course in User Interface Design, and would be more than happy to work with you on this. I worked at Creo/Kodak for 10 years doing UI Design and Implementation. For now, I will offer some considerations

      1. The easiest UI elements to add are simply labeled hyperlinks, where the customer can point to any URI that will take the user to the appropriate documentation.
        • For example, supporting this in the Public Description and Internal Description fields should be a simple fix, where it renders the hyperlink as part of the text. Markdown format of [Lable](URI) should suffice. Clicking it should open the URI in a new browser window or tab.
      2. The next level up is to add more UI elements that can include a URI, but this can be risky as it could make the UI too cluttered if done poorly.
      3. A Cadilac Solution is to support mouse-overs or mouse-hovers, where when the user hovers the mouse over any UI element and it pops up context documentation. For people who use Eclipse or IntelliJ IDEs, this is a familiar experience.
        • My recommended behaviour is that in the UI when someone hovers the mouse over an element, it will display a contextual pop-up dialogue with an explanation.
        • The default pop-up could include JFrog defined text but does not need to.
        • The default pop-up should include a control or hyperlink such as "Edit" or "Edit Description" where anyone can edit this but might be restricted to Admins or people with Documentation privileges (see above).
        • The Description Pop-Up should be able to hold hyperlinks such as [Label](URI).

      My biggest pain point with JFrog so far is the complexity of the product, its features, and behaviours, as well as the difficultly of finding and navigating the documenation. Rather than rely on JFrog to remedy these problems, giving customers the ability to document the UI, relieves the burden on JFrog, and grants customers an Internal Locus of Control (UI/UX term) to better serve their own needs.





            ekolotyluk Eric Kolotyluk
            0 Vote for this issue
            2 Start watching this issue



                Sync Status

                Connection: RTFACT Sync
                RTMID-26391 -
                • Last Sync Date: