search

instructlab / schema

JSON schema for Taxonomy YAML
Apache License 2.0
0 stars 7 forks source link

Cross-component design artifact repository #4

Closed russellb closed 3 months ago

russellb commented 3 months ago

I feel we need a home for architecture and design documentation for issues that span multiple components. The schema is one example of a detail that needs to be coordinated across components, but there are others, particularly with backend automation, and automation with GitHub to assist in taxonomy development, triage, and review.

This repository seems like a good candidate for an expanded scope. If so, I would rename the repo. Naming is hard, but some ideas:

... something like that.

russellb commented 3 months ago

PR to start this: https://github.com/instruct-lab/schema/pull/5

bjhargrave commented 3 months ago

This repo was initially suggested to be "api" (like k8s' api repo) as a shared API-level repo. It was scoped down to just "schema" when created as we had no concrete need for anything else. But if we have something more concrete to add, it may make sense to rename.

bjhargrave commented 3 months ago

But the plan is to git submodule this repo in taxonomy and cli so they both have the schema files.

If there is more in here, that increases the amount of data submoduled.

So perhaps another repo is needed for arch docs.

russellb commented 3 months ago

But the plan is to git submodule this repo in taxonomy and cli so they both have the schema files.

If there is more in here, that increases the amount of data submoduled.

So perhaps another repo is needed for arch docs.

OK. In that case, a separate enhancements repo would make sense and cause less disruption at the moment.

russellb commented 3 months ago

Created a new repo here: https://github.com/instruct-lab/enhancements