Uploaded image for project: 'Migration Toolkit for Virtualization'
  1. Migration Toolkit for Virtualization
  2. MTV-3749

DOC: [UI] Add plan description

XMLWordPrintable

    • Quality / Stability / Reliability
    • False
    • Hide

      None

      Show
      None
    • False
    • Not Selected

      The underlying feature (Epic MTV-3747) introduces a new, simple text field in the Migration Plan creation wizard that allows administrators to add a descriptive purpose or note to the plan. This feature directly addresses the user story: As a cluster administrator, I want to be able to describe a plan purpose, so that I can easily differ between the different plans.

      Technical Writer Scope

      The primary documentation task is to ensure the new field and its visibility are clearly captured in the procedural guide. Key areas include:

      1. UI Procedural Update: Update the Migration Plan Creation guide with new screenshots and instructions for the step where the user enters the plan name and now the plan description.
      1. Plan Details Page: Confirm and document where this new description is displayed after the plan is created (e.g., on the main plan list view or the plan details page) to facilitate easy differentiation and management.
      1. Content Best Practices: Advise users on best practices for writing effective plan descriptions (e.g., "Use case," "Targeted downtime," "Date created") to maximize the value of this organizational feature.

      JTBD Statement:

      "When I am viewing a long list of migration plans in the web console, I want to easily add a detailed, descriptive note to each plan so that I can quickly identify the purpose, scope, and owner of the plan without opening the details, thereby simplifying collaboration and avoiding confusion between similar migration tasks."

      Documentation Task

      The documentation task (MTV-3749) supports this job by addressing the primary sub-job:

      "When the plan description feature is implemented, I need documentation that shows where to enter the description and where it is visible later so that I can be confident the added context is accessible and useful for myself and my team members for long-term management and auditing."

      Goal

      Today, the UI does not expose a way to describe a plan with simple text.

      After this epic, the UI will expose a way to describe a plan with simple text.  

      User Stories

      • As a cluster administrator,
        I want to be able to describe a plan purpose,
        so that I can easily differ between the different plans.

              rhn-support-anarnold A Arnold
              mschatzm@redhat.com Matan Schatzman
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: