Uploaded image for project: 'Red Hat Internal Developer Platform'
  1. Red Hat Internal Developer Platform
  2. RHIDP-10013

Create Documentation for Lightspeed Integration setup

    • Create Documentation for Lightspeed Integration
    • False
    • Hide

      None

      Show
      None
    • False
    • To Do
    • RHDHPLAN-223 - [Lightspeed] Spike: AI Flavor Installer
    • 100% To Do, 0% In Progress, 0% Done

      Epic Goal

      • Provides documentation for setting up lightspeed integration using supported methods
        • Manual setup
        • Integrations CLI
      • Provides documentation in a central location

      Why is this important?

      • Provides developers and early adopters instruction to setup the Lightspeed RHDH integration
      • Consolidates existing manuals to a central point of reference

      Scenarios

      1. Manual Setup Documentation
        • It should be included as part of the installation documentation for RHDH AI technologies as well as grouped into the installation steps specifically for lightspeed
        • This should cover the manual setup steps under this documentation.
          • How to setup the infrastructure required for Lightspeed Integration
          • How to setup the resources required Lightspeed Integration
          • How to setup Lightspeed Integration with RHDH
        • This documentation should have its own subsection and does not depend on other lightspeed setup documentation (i.e. using the RHDH helm charts or just integration CLI)
        • We can consolidate and revise all setup and installation documentation we currently have under various repositories under this documentation to have in one place
      2. Integration CLI Documentation
        • It should be included as part of the installation documentation for RHDH AI technologies as well as grouped into the installation steps specifically for lightspeed
        • Integration CLI setup steps should be included under this documentation
        • This documentation should have its own subsection and does not depend on other lightspeed setup documentation (i.e. using the RHDH helm charts or manual setup of lightspeed)

      Acceptance Criteria (Mandatory)

      • CI - MUST be running successfully with tests automated
      • Release Technical Enablement - Provide necessary release enablement details and documents.
      • All scenarios must be documented

      Dependencies (internal and external)

      1. ...

      Previous Work (Optional):

      Open questions::

      Done Checklist

      • Acceptance criteria are met
      • Non-functional properties of the Feature have been validated (such as performance, resource, UX, security or privacy aspects)
      • User Journey automation is delivered
      • Support and SRE teams are provided with enough skills to support the feature in production environment

              Unassigned Unassigned
              mvaldron Michael Valdron
              RHIDP - AI
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: