Story (Required)

As a Platform Engineer, I should be able to provide documentation about each model server in my organization that includes: Basic information about the model server (incl. models on the model server), how to access the server, how to authenticate, and any usage restrictions for the model server.

As an Application Developer, I should be able to easily view that information from within a model server’s Component catalog entry. The information should be clear to understand and written in a consistent manner.

Background (Required)

As part of DEVAI-XYZ, a way to model AI assets (models, model servers) in a Backstage catalog will be implemented. This issue will focus on providing a consistent way to document basic model server metadata, that isn’t covered by fields in Backstage Resources. This information may include how to access the server, how to authenticate, and any usage restrictions for the model server.

One or more techdocs (in the form of a markdown file) should be provided that provides that necessary information for the model server. It should be formatted in a way such that its template can be reused, regardless of the model server that it’s for.

Out of scope

• Any documentation needed for the model server

Approach (Required)

• Define a techdoc format providing information about models in an organization
• Document structure and how users can create their own model server documentation. Which sections should be included, and what should be in each section

Dependencies

Acceptance Criteria (Required)

• Specification provided that implements the Model Catalog API (e.g. Google Doc or Git repo)
• Every, eligible non-techdoc related field in the Model Catalog API is implemented

Done Checklist