Uploaded image for project: 'Red Hat Enterprise Linux AI'
  1. Red Hat Enterprise Linux AI
  2. RHELAI-4041

[instructlab/ui] [UX] Handling and Displaying Draft Contributions and Changes to Existing Contributions

XMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False

      [3032655322] Upstream Reporter: Missy Johnson
      Upstream issue status: Closed
      Upstream description:

      Problem Statement

      Based on internal conversations with development and UX, we believe users may not fully understand how RHELAI/InstructLab handles:

      • Editing an existing contribution
      • Saving a draft of a new contribution

      This document outlines the current behavior, user expectations, and considerations for improving clarity and usability.

      ?

      Current Behavior

      New Contributions

      • When a user creates a new contribution but does not submit it, it appears as a Draft in the My Contributions section of the Dashboard.
      • When the user submits the draft, its status changes from Draft to Submitted.

      Editing Existing Contributions

      • If a user edits an already submitted contribution without submitting, the platform creates a Draft.
      • When the user submits the edited draft, it overwrites the existing submission. It does not create a new version or contribution.
      • When the user submits this draft, its status changes from Draft to Submitted.

      Options for Handling Edits and File Changes

      1. Overwriting
      • Replaces the current version of the contribution with new data.
      • Previous versions are not retained or recoverable.
      1. Versioning
      • Saves a new copy of the contribution.
      • Allows users to view or revert to previous versions.
      • More transparent for tracking changes and reviewing history.

      Research Questions & Considerations

      • What behavior do users expect when editing a submitted contribution?
      • Should document editing follow the same behave as contributions?
      • Why might users want to revert to an older version? -- Undo mistakes -- Compare previous and new iterations -- Restore accidentally deleted content -- Others?
      • Why might users prefer to overwrite? -- Simplified experience -- Less clutter or confusion -- Others?
      • What actions do users expect to be available on a new draft? -- Edit -- Delete -- Submit -- Others?
      • What actions do users expect to be available on a draft of an existing contribution? -- Edit -- Delete -- Submit -- Others?
      • What actions do users expect to be available on a submitted contribution? -- Edit -- Duplicate -- Track history

      Initial Thoughts

      • Drafts of new contributions appear at the top (parent-level) in the Dashboard.
      • Drafts of existing submissions are nested beneath the submitted version.
      • Once submitted, a draft replaces the existing contribution.
      • We should not support multiple drafts for a single submission to prevent confusion and content sprawl.

      Deliverables

      • Workflow diagram
      • Lofi wireframes
      • Hifi mockups

      Resources


      Upstream URL: https://github.com/instructlab/ui/issues/760

              misjohns@redhat.com Missy Johnson
              upstream-sync Upstream Sync
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: