Skip to content

[documentation] missing README for model-config-datasource plugin #192

Description

@ronenkat

What happened:

The model-config-datasource datalayer plugin (pkg/framework/plugins/datalayer/modelconfigcollector/) has no README.md. There is no documentation describing what the plugin does, how to configure it, the expected config file format, or its runtime behavior.

What you expected to happen:

A README.md exists in the plugin directory that documents:

  • Purpose and behavioral intent of the plugin
  • Config file format (modelsPath JSON schema)
  • Plugin configuration fields and an example snippet
  • Inputs consumed and outputs produced

How to reproduce it (as minimally and precisely as possible):

  1. Navigate to pkg/framework/plugins/datalayer/modelconfigcollector/.
  2. Observe that only plugin.go and plugin_test.go are present — no README.md.

Anything else we need to know?:

Other plugins in the repository include a README.md following a consistent format. The model-config-datasource plugin should follow the same convention.

Environment:

  • Kubernetes version (use kubectl version): N/A
  • llm-d-scheduler version (use git describe --tags --dirty --always if you built from source, or specify the tag if you used a tagged version or image): N/A
  • Cloud provider or hardware configuration: N/A
  • Install tools: N/A
  • Others: N/A

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions