Story (Required)

• As an AI developer, I would like the models and model servers I access in RHDH to have documentation associated with them
• As a Platform Engineer, I would like to have a way to associate documentation with the model and model servers that get imported into RHDH

Background (Required)

RHDHPAI-607 covers the work for manual techdoc creation for models and model servers in the RHDH Model Catalog.

Platform Engineers wishing to manually provide documentation for specific model catalog entities in RHDH, should be provided a way to do so. We previously wrote up a couple guides on how to write model / model server techdocs[1][2], which should provide a helpful starting basis. In addition to structuring and writing the techdocs, we also need to provide instructions on how to get associate their techdocs with the models/model servers they are about. Previous discussions with gmontero@redhat.com and eyuen@redhat.com suggested a label on the model/inference server resource(s) should be sufficient to do so.

[1] https://github.com/redhat-ai-dev/model-catalog-example/blob/main/tutorials/model-guide.md
[2] https://github.com/redhat-ai-dev/model-catalog-example/blob/main/tutorials/model-server-guide.md

Out of scope

• Curated techdocs (see RHDHPAI-696)

Approach (Required)

• Write up instructions on how platform engineers can write techdocs for models and model servers (starting with the previous model and model server documentation linked above)

• • These instructions have already been reviewed from both UX and Docs, and should serve as a useful starting point
• Provide instructions on how to associate techdocs with the models / model servers they are about

Dependencies

Acceptance Criteria (Required)

• Instructions provided on how to create and structure model / model server techdocs
• Instructions provided on how to associate techdocs with models/model servers (e.g. via label on a Kubernetes resource)

documentation updates (design docs, release notes etc)
demo needed
SOP required
education module update (Filled by RHDHPAI team only)
R&D label required (Filled by RHDHPAI team only)

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