Epic Goal

In addition to importing model and model server entities into the RHDH catalog, we will need to display some of the relevant documentation for the entities in the form of techdocs (https://backstage.io/docs/features/techdocs/).

Our backend module defined in RHDHPAI-605 should extend off the techdocs plugin and have support for ingesting new techdocs that are provided by the Model Catalog Bridge.

On the model catalog bridge side - the bridge should be able to fetch the necessary documentation from the necessary sources (just RHOAI MR currently), and to store them in an appropriate database. The bridge service should handle syncing the techdocs between the bridge and the model catalog.

Why is this important?

• The model and model server documentation form an important part of the model catalog, covering aspects like how to access model resources, how to authenticate, and usage restrictions and examples.

Scenarios

1. Techdoc integration with Backend plugin: Extend our backend plugin to integrate with the techdocs plugin, and provide ways to generate techdocs for imported models/model servers. 
2. Model Registry Techdoc Mapping: Investigate the mapping between the RHOAI MR documentation (e.g. ModelCarD) and the techdocs we need to display in RHDH
3. Model Registry Techdoc Update: Provide a lifecycle for the techdocs to be regularly synced/updated with what’s present in MR, if we’re not able to use the existing catalog sync functionality
4. Model documentation: As an AI developer, I want to access documentation for models imported through the plugin/bridge, including model cards, licenses, usage instructions
5. Model Server documentation: As an AI developer, I want to access documentation for model servers imported through the plugin/bridge, including how to access, authentication information, and usage examples

Acceptance Criteria (Mandatory)

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

Dependencies (internal and external)

1. ...

Previous Work (Optional):

1. …

Open questions::

1. …

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