Skip to content

Commit 66c5f5b

Browse files
authored
📝 Defined a way to manage EinStack Glide project (#234)
1 parent 2db285c commit 66c5f5b

File tree

4 files changed

+2025
-51
lines changed

4 files changed

+2025
-51
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,3 +73,24 @@ That's perfectly fine!
7373
Feel free to connect with us in [Discord](https://discord.gg/rsBzprY7uT) and ask any question you have.
7474
Remember, there are no dumb questions, but there can be missing opportunities to make your life easier if you don't speak up about things you struggle with.
7575

76+
77+
78+
## Project Management
79+
80+
EinStack uses Github functionality to do all sorts of management and planning of Glide functionality:
81+
82+
- We use Github Projects to manage [the Glide's roadmap](https://github.com/orgs/EinStack/projects/1/views/4)
83+
- We use Github issues to manage epics (e.g. bigger functionality that would not fit one task or pull request) and the corresponding tasks
84+
- Github issue labels to indicate epic priority and other horizontal properties of the functionality like type, area, etc
85+
- Github milestones to assign epics to upcoming releases which may be connected to Glide incremental releases or solve some specific use case (e.g. RAG)
86+
87+
<img src="docs/images/einstack-project-management.png" width="400px" alt="Glide Project Management" />
88+
89+
### How to add a new epic?
90+
91+
You can do that by:
92+
- creating a new Github issue
93+
- assigning the `type:epic` to it
94+
- adding it to [the Glide Roadmap project](https://github.com/orgs/EinStack/projects/1/views/4) (the backlog status)
95+
96+
Be sure to let everyone know about this in the EinStack Discord (#general channel is fine).

ROADMAP.md

Lines changed: 7 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,12 @@
1-
*Updated: Wed, Jan 31st, 2024*
1+
# Glide Roadmap
22

3-
# Glide - Roadmap
3+
Glide uses a Github project functionality to manage roadmap:
44

5-
This document describes the current status and the upcoming milestones of the Glide gateway.
5+
- [Glide's roadmap](https://github.com/orgs/EinStack/projects/1/views/4)
66

7-
## Glide
7+
Please upvote or comment on issues that you would like to be implemented or solved in Glide.
8+
We pay attention to that information during prioritization.
89

9-
### Milestone Summary
10+
Open [an issue](https://github.com/EinStack/glide/issues) or start [a discussion](https://github.com/EinStack/glide/discussions) if there is a feature, enhancement, or use case
11+
you'd like to see supported in Glide.
1012

11-
| Status | Milestone | Goals |
12-
| :---: | :--- | :---: |
13-
| 🍏 | **Unified Chat API** | 4 / 4 |
14-
| 🍏 | **Fallback Routing Strategy** | 1 / 1 |
15-
| 🍏 | **Priority, Round Robin, Weighted Round Robin, Least Latency** | 4 / 4 |
16-
| 🍏 | **Documentation** | 1 / 1 |
17-
| 🍎 | **Private Preview** | 4.5 / 5 |
18-
| 🍎 | **Streaming Support** | 0 / 4 |
19-
| 🍎 | **Embedding Support** | 0 / 4 |
20-
| 🍎 | **Caching** | 0 / 1 |
21-
| 🍎 | **Public Preview** | 0 / 3 |
22-
| 🍎 | **Python SDK** | 0 / 1 |
23-
| 🍎 | **STT & TTS Model Support** | 0 / 2 |
24-
| 🍎 | **Intelligent Routing** | 0 / 1 |
25-
| 🍎 | **General Availability Routing** | 0 / 1 |
26-
27-
### Private Preview ✅ ([v0.0.1](https://github.com/EinStack/glide/releases/tag/0.0.1))
28-
29-
- Unified LLM Chat REST API
30-
- Support for most popular LLM providers
31-
- Seamless model fallbacking
32-
- Routing Strategies: Priority, Round Robin, Weighted Round Robin, Least Latency
33-
34-
### Public Preview (In Progress)
35-
36-
- Unified Embeddings API
37-
- Unified Steaming Chat API
38-
- Observability
39-
- The Exact Caching
40-
- Intelligent Routing (?)
41-
42-
### General Availability
43-
44-
- Kubernetes Insallation (Helm Chart)
45-
- Python SDK
46-
- Speech-to-text & Text-to-speech models
47-
- The Semantic Caching
48-
49-
### Future
50-
51-
- Cost Management & Budgeting
52-
- Safety & Control Over Inputs & Outputs
53-
- and many more!
54-
55-
Open [an issue](https://github.com/EinStack/glide/issues) or start [a discussion](https://github.com/EinStack/glide/discussions)
56-
if there is a feature or an enhancement you'd like to see in Glide.

0 commit comments

Comments
 (0)