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

step1: Automate revision of converted documents [L3]

XMLWordPrintable

    • Icon: Feature Feature
    • Resolution: Unresolved
    • Icon: Critical Critical
    • None
    • None
    • Fit and Finish
    • None
    • False
    • Hide

      None

      Show
      None
    • False
    • Not Selected

      Feature Overview (mandatory - Complete while in New status)

      Conversion to a .md file(s) can be riddled with errors. We need to provide an easy, automated way to fix the errors found in the previous step (i.e. during review) and fix them. 

      Goals (mandatory - Complete while in New status)

      Provide high-level goal statement, providing user context and expected user outcome(s) for this Feature

      • Users can easily run the notebook 

      Requirements (mandatory -_ Complete while in Refinement status):
      A list of specific needs, capabilities, or objectives that a Feature must deliver to satisfy the Feature. Some requirements will be flagged as MVP. If an MVP gets shifted, the Feature shifts. If a non MVP requirement slips, it does not shift the feature.

      Requirement Notes isMVP?
      Provide a notebook with well-documented steps: input format, path, output format, path, libraries used etc
      Consider how this particular notebook’s inputs/outputs flow with the next notebook in the process - how is it all put together?
      Ensure file paths, output types etc are consistent
        Yes
      Provide an easy way for users to view their fixed markdown files   Yes
      Provide an easy way for users to view the errors    Yes
      Provide clear documentation of what was fixed etc.   Yes
      Potentially a demo showing: how will this be run on RHEL AI? with Elyra? Workbench container?   No
      Show how a user would work through a folder of documents - show progress bars   No

       
      Done - Acceptance Criteria (mandatory - Complete while in Refinement status):
      Acceptance Criteria articulates and defines the value proposition - what is required to meet the goal and intent of this Feature. The Acceptance Criteria provides a detailed definition of scope and the expected outcomes - from a users point of view. * Ensure it passes UX reviews ([reqs documented here|https://github.com/instructlab/examples/blob/main/Notebook-UX-Review-Template.md])

       

      Use Cases - i.e. User Experience & Workflow: (Initial completion while in Refinement status):
      Include use case diagrams, main success scenarios, alternative flow scenarios.
      <your text here>

      Out of Scope {}{}(Initial completion while in Refinement status):
      High-level list of items or persona’s that are out of scope.
      <your text here>

      Documentation Considerations {}{}(Initial completion while in Refinement status):
      Provide information that needs to be considered and planned so that documentation will meet customer needs. If the feature extends existing functionality, provide a link to its current documentation..
      <your text here>

       

      Questions to Answer {}{}(Initial completion while in Refinement status):
      Include a list of refinement / architectural questions that may need to be answered before coding can begin.
      <your text here>

      Background and Strategic Fit (Initial completion while in Refinement status):
      Provide any additional context is needed to frame the feature.
      <your text here>

      Customer Considerations {}{}(Initial completion while in Refinement status):
      Provide any additional customer-specific considerations that must be made when designing and delivering the Feature.
      <your text here>

      Team Sign Off (Completion while in Planning status)

      • All required Epics (known at the time) are linked to the this Feature
      • All required Stories, Tasks (known at the time) for the most immediate Epics have been created and estimated
      • Add - Reviewers name, Team Name
      • Acceptance == Feature as “Ready” - well understood and scope is clear - Acceptance Criteria (scope) is elaborated, well defined, and understood
      • Note: Only set FixVersion/s: on a Feature if the delivery team agrees they have the capacity and have committed that capability for that milestone
      Reviewed By Team Name Accepted Notes
             
             
             
             

       

              Unassigned Unassigned
              jepandit@redhat.com Jehlum Vitasta Pandit
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: