Skip to content
This repository was archived by the owner on Sep 9, 2025. It is now read-only.

Commit 2ce89f1

Browse files
authored
Merge pull request #69 from russellb/backend
Propose a backend working group
2 parents 6ccd2bf + 2d15c45 commit 2ce89f1

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

docs/backend/README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# InstructLab Backend Working Group
2+
3+
## Introduction
4+
5+
The InstructLab project to date has produced a
6+
[CLI](https://github.com/instructlab/instructlab) that allows the execution of
7+
the InstructLab workflow on a variety of single-machine footprints.
8+
9+
Some members of the InstructLab project also operate some backend services that
10+
produce regular full model builds using contributions to the
11+
[taxonomy](https://github.com/instructlab/taxonomy/). This runs in a larger
12+
clustered environment. This original backend is not built in a way that is
13+
easily reusable by others. It is a goal of the InstructLab project to produce an
14+
evolution of these backend capabilities that is more easily reusable by others.
15+
16+
The InstructLab Backend Working Group represents a group of contributors
17+
interested in evolving the InstructLab backend capabilities. The group is open
18+
to all contributors interested in this work.
19+
20+
## Group Membership
21+
22+
There is no formal membership of this group. Those interested in contributing
23+
just need to show up and participate in the work of the group.
24+
25+
## Primary Artifacts Produced by the Group
26+
27+
The primary artifacts produced by the InstructLab Backend Working Group are
28+
architecture and design docs in the `docs/backend` directory of this repository.
29+
This is where the group will work out high-level planning for various components
30+
that should be created.
31+
32+
Once individual components are created and implementation is in progress, code
33+
and associated documents for that component will be stored in those
34+
repositories.
35+
36+
## Communication
37+
38+
Communication among the group occurs in the following ways:
39+
40+
- **Meetings**: The group meets regularly on a schedule determined by the group.
41+
Meetings are open to all interested contributors. Meeting times are posted in
42+
the [InstructLab Community
43+
Calendar](https://calendar.google.com/calendar/embed?src=c_23c2f092cd6d147c45a9d2b79f815232d6c3e550b56c3b49da24c4b5d2090e8f%40group.calendar.google.com).
44+
45+
- **Slack**: The group uses the `#backend` channel in the InstructLab Slack.
46+
47+
- **Mailing Lists**: There is a [development mailing
48+
list](https://groups.google.com/a/instructlab.ai/g/dev) should the group desire
49+
to share or discuss topics by email.
50+
51+
- **GitHub**: Artifacts produced by this group will be stored in the
52+
`docs/backend` directory of this repository and will be reviewed via GitHub
53+
pull requests. GitHub Issues may also be used to track work items as needed.

0 commit comments

Comments
 (0)