Uploaded image for project: 'OpenShift GitOps'
  1. OpenShift GitOps
  2. GITOPS-5082

Multi-source: Improve usability of rollback and history page

XMLWordPrintable

    • 8
    • False
    • Hide

      None

      Show
      None
    • False
    • Hide
      With this update, you can view the revision history and rollback page in a more compact way. Collapsible sections show or hide the application input parameters. This change improves the usability of the view so that users do not have to scroll down multiple lines of input parameters to reach the other revision history entries. The more important information of the revision including the commit SHA remain outside of the collapsible sections so users can search for the SHA. The collapsible section appears for both single source and multi-source applications.
      Show
      With this update, you can view the revision history and rollback page in a more compact way. Collapsible sections show or hide the application input parameters. This change improves the usability of the view so that users do not have to scroll down multiple lines of input parameters to reach the other revision history entries. The more important information of the revision including the commit SHA remain outside of the collapsible sections so users can search for the SHA. The collapsible section appears for both single source and multi-source applications.
    • GitOps Tangerine - Sprint 3264, GitOps Tangerine - Sprint 3265

      Story (Required)

      As a user performing a rollback in the Argo CD UI, I want the rollback and history page to display the revision history of a multi-source application in a more usable, comprehensive and sensible way.

      Background (Required)

      The original contribution (https://github.com/argoproj/argo-cd/pull/14124) by Jorge (an external contributor) shows all the source parameters in a 'flat' way, one source after another, and for Helm input parameters, it can be very long.  It can be quite the task to find the revision you want to rollback because you will have to scroll down a lot.

      Now that it has been merged, we can proceed with improving the usability, and use collapsible sections (and possibly pagination) like that found in the Details panel, Sources tab. (https://github.com/argoproj/argo-cd/pull/17275) 

      Out of scope

      None

      Approach (Required)

      Come up with a design and implementation that will be consistent with the current Sources tab (or make necessary changes in both pages) to improve usability. The general idea is to use collapsible sections to represent each 'revision history' entry that will have multiple sources. Note that this information is read-only. Also, the left margin shows the deployment information and time, etc. so that should be preserved.

      Another consideration is that this page must still work for single source apps, (apps that use the source field), you might want to keep it the same design as before. (Because that will be deprecated and removed.  In other words, you may not want to convert it to a single source, collapsible section). Note that this is different than an app using the sources field, and it only has one source reference.  In that case, it should be a special case of the general multi-source app and it should have one collapsible section for that one source..

      You should test both multi-source apps and single source apps thoroughly.

      Dependencies

      No dependencies.  The current multi-source support is merged.

      Acceptance Criteria (Mandatory)

      • The history and rollback page should show the revision history in a more user friendly, compact way by means of collapsible sections, for multi-source apps
      • For single source apps using the source field, it should continue to work as before, with no regression in behaviour
      • Functional verification testing is done for both multi-source and single-source apps

      INVEST Checklist

      Dependencies identified

      Blockers noted and expected delivery timelines set

      Design is implementable

      Acceptance criteria agreed upon

      Story estimated

      Legend

      Unknown

      Verified

      Unsatisfied

      Done Checklist

      • Code is completed, reviewed, documented and checked in
      • Unit and integration test automation have been delivered and running cleanly in continuous integration/staging/canary environment
      • Continuous Delivery pipeline(s) is able to proceed with new code included
      • Customer facing documentation, API docs etc. are produced/updated, reviewed and published
      • Acceptance criteria are met

              kykchong@redhat.com Keith Chong
              kykchong@redhat.com Keith Chong
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: