Story (Required)

As a developer consuming AI software templates, I would like to know how to easily build and run my sample applications within RHOAI.

Background (Required)

Currently our software templates provide an integration with OpenShift AI, where a workbench can be created alongside the sample application's resources. The OpenShift AI workbench can be used to build and develop local changes for the applications, however instructions on how to do so are unclear. (see https://drive.google.com/drive/u/0/folders/1JA0U8sG-zwJSpS1ImhuAm1eKooiosaDh for an example).

It would be nice if each sample application provided a markdown file with basic instructions on how to build, run, and access the application from within RHOAI.

Currently, since all of our samples are based on the same stack (StreamLit), the instructions can be identical for all 3 apps, but in the future, additional samples may require specific instructions.

Out of scope

<Defines what is not included in this story>

Approach (Required)

• Write up instructions for build and running each sample app within RHOAI
• Modify the generate.sh script in https://github.com/redhat-ai-dev/ai-lab-template to include those instructions
• If any samples needed specific instructions different from the other samples, handle those cases as well

Dependencies

<Describes what this story depends on. Dependent Stories and EPICs should be linked to the story.>

Acceptance Criteria (Required)

• Application source repository includes instructions on how to build, run, and access the application from within RHOAI
• Instructions should be in the form of a markdown file (BUILD-AND-RUN-RHOAI.md?) that can be displayed within the RHOAI workbench
• Instructions should be clear and concise, and cover the minimum set of steps the user needs to follow

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, design docs etc. are produced/updated, reviewed and published
Acceptance criteria are met
If the Grafana dashboard is updated, ensure the corresponding SOP is updated as well