Skip to content

Commit 7d0895c

Browse files
authored
Merge pull request #2171 from tisnik/lcore-2933-maintenance
LCORE-2933: Maintenance doc restructuring
2 parents 57a9687 + 988184a commit 7d0895c

16 files changed

Lines changed: 49 additions & 71 deletions

docs/README.md

Lines changed: 23 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ See the full documentation at [`../README.md`](../README.md) or browse sub-pages
1111
* [User docs](#user-docs)
1212
* [Developer doc](#developer-doc)
1313
* [API](#api)
14+
* [Models](#models)
15+
* [Testing](#testing)
1416
* [Maintenance](#maintenance)
15-
* [Migration guides](#migration-guides)
16-
* [Models](#models)
1717
* [Design documents](#design-documents)
1818
* [Agent skills](#agent-skills)
1919
* [Automatic conversation expiration](#automatic-conversation-expiration)
@@ -24,8 +24,6 @@ See the full documentation at [`../README.md`](../README.md) or browse sub-pages
2424
* [Llama Stack config merge (unified `lightspeed-stack.yaml`)](#llama-stack-config-merge-unified-lightspeed-stackyaml)
2525
* [Low overhead deployment for server mode](#low-overhead-deployment-for-server-mode)
2626
* [OpenTelemetry tracing in Lightspeed Core](#opentelemetry-tracing-in-lightspeed-core)
27-
* [Testing](#testing)
28-
* [Releasing](#releasing)
2927
* [Demos](#demos)
3028

3129
<!-- vim-markdown-toc -->
@@ -54,6 +52,8 @@ See the full documentation at [`../README.md`](../README.md) or browse sub-pages
5452

5553
[User data collection](https://lightspeed-core.github.io/lightspeed-stack/user_doc/user_data_collection.html)
5654

55+
[Sentry error tracking](https://lightspeed-core.github.io/lightspeed-stack/sentry.html)
56+
5757
## Developer doc
5858

5959
[Architecture](https://lightspeed-core.github.io/lightspeed-stack/devel_doc/ARCHITECTURE.html)
@@ -78,38 +78,43 @@ See the full documentation at [`../README.md`](../README.md) or browse sub-pages
7878

7979
[Conversations API](https://lightspeed-core.github.io/lightspeed-stack/devel_doc/conversations_api.html)
8080

81+
### Models
8182

82-
## Maintenance
83+
[Common](https://lightspeed-core.github.io/lightspeed-stack/models/common.html)
8384

84-
[Status of Lightspeed Core Stack versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/version_status.html)
85+
[Database](https://lightspeed-core.github.io/lightspeed-stack/models/database.html)
8586

86-
[Supported versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/versions_supported.html)
87+
[Requests](https://lightspeed-core.github.io/lightspeed-stack/models/requests.html)
8788

88-
[Unsupported versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/versions_unsupported.html)
89+
[Successful responses](https://lightspeed-core.github.io/lightspeed-stack/models/responses_succ.html)
8990

90-
## Migration guides
91+
[Error responses](https://lightspeed-core.github.io/lightspeed-stack/models/responses_errors.html)
9192

92-
[Migration guides](https://lightspeed-core.github.io/lightspeed-stack/migrations/)
93+
[Compaction](https://lightspeed-core.github.io/lightspeed-stack/models/compaction.html)
9394

95+
### Testing
9496

95-
[Sentry error tracking](https://lightspeed-core.github.io/lightspeed-stack/sentry.html)
97+
[Testing](https://lightspeed-core.github.io/lightspeed-stack/testing.html)
9698

99+
[End-to-End Tests Guide](https://lightspeed-core.github.io/lightspeed-stack/e2e_testing.html)
97100

101+
[List of e2e scenarios](https://lightspeed-core.github.io/lightspeed-stack/e2e_scenarios.html)
98102

99-
## Models
103+
## Maintenance
100104

101-
[Common](https://lightspeed-core.github.io/lightspeed-stack/models/common.html)
105+
[Status of Lightspeed Core Stack versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/version_status.html)
102106

103-
[Database](https://lightspeed-core.github.io/lightspeed-stack/models/database.html)
107+
[Supported versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/versions_supported.html)
104108

105-
[Requests](https://lightspeed-core.github.io/lightspeed-stack/models/requests.html)
109+
[Unsupported versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/versions_unsupported.html)
106110

107-
[Successful responses](https://lightspeed-core.github.io/lightspeed-stack/models/responses_succ.html)
111+
[Migration guides](https://lightspeed-core.github.io/lightspeed-stack/migrations/)
108112

109-
[Error responses](https://lightspeed-core.github.io/lightspeed-stack/models/responses_errors.html)
113+
[Branching](https://lightspeed-core.github.io/lightspeed-stack/maintenance/branching.html)
110114

111-
[Compaction](https://lightspeed-core.github.io/lightspeed-stack/models/compaction.html)
115+
[Releasing](https://lightspeed-core.github.io/lightspeed-stack/maintenance/releasing.html)
112116

117+
[LTS process overview](https://lightspeed-core.github.io/lightspeed-stack/maintenance/lts_flow.html)
113118

114119
## Design documents
115120

@@ -161,22 +166,6 @@ See the full documentation at [`../README.md`](../README.md) or browse sub-pages
161166

162167
[Design](https://lightspeed-core.github.io/lightspeed-stack/design/observability-opentelemetry/observability-opentelemetry.html)
163168

164-
## Testing
165-
166-
[Testing](https://lightspeed-core.github.io/lightspeed-stack/testing.html)
167-
168-
[End-to-End Tests Guide](https://lightspeed-core.github.io/lightspeed-stack/e2e_testing.html)
169-
170-
[List of e2e scenarios](https://lightspeed-core.github.io/lightspeed-stack/e2e_scenarios.html)
171-
172-
## Releasing
173-
174-
[Branching](https://lightspeed-core.github.io/lightspeed-stack/branching.html)
175-
176-
[Releasing](https://lightspeed-core.github.io/lightspeed-stack/releasing.html)
177-
178-
[LTS provess overview](https://lightspeed-core.github.io/lightspeed-stack/lts_flow.html)
179-
180169
## Demos
181170

182171
[LCORE introduction](https://lightspeed-core.github.io/lightspeed-stack/demos/lcore/lcore.html#/)

docs/index.md

Lines changed: 23 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ product questions using backend LLM services, agents, and RAG databases.
1818
* [User docs](#user-docs)
1919
* [Developer doc](#developer-doc)
2020
* [API](#api)
21+
* [Models](#models)
22+
* [Testing](#testing)
2123
* [Maintenance](#maintenance)
22-
* [Migration guides](#migration-guides)
23-
* [Models](#models)
2424
* [Design documents](#design-documents)
2525
* [Agent skills](#agent-skills)
2626
* [Automatic conversation expiration](#automatic-conversation-expiration)
@@ -31,8 +31,6 @@ product questions using backend LLM services, agents, and RAG databases.
3131
* [Llama Stack config merge (unified `lightspeed-stack.yaml`)](#llama-stack-config-merge-unified-lightspeed-stackyaml)
3232
* [Low overhead deployment for server mode](#low-overhead-deployment-for-server-mode)
3333
* [OpenTelemetry tracing in Lightspeed Core](#opentelemetry-tracing-in-lightspeed-core)
34-
* [Testing](#testing)
35-
* [Releasing](#releasing)
3634
* [Demos](#demos)
3735

3836
<!-- vim-markdown-toc -->
@@ -61,6 +59,8 @@ product questions using backend LLM services, agents, and RAG databases.
6159

6260
[User data collection](https://lightspeed-core.github.io/lightspeed-stack/user_doc/user_data_collection.html)
6361

62+
[Sentry error tracking](https://lightspeed-core.github.io/lightspeed-stack/sentry.html)
63+
6464
## Developer doc
6565

6666
[Architecture](https://lightspeed-core.github.io/lightspeed-stack/devel_doc/ARCHITECTURE.html)
@@ -85,38 +85,43 @@ product questions using backend LLM services, agents, and RAG databases.
8585

8686
[Conversations API](https://lightspeed-core.github.io/lightspeed-stack/devel_doc/conversations_api.html)
8787

88+
### Models
8889

89-
## Maintenance
90+
[Common](https://lightspeed-core.github.io/lightspeed-stack/models/common.html)
9091

91-
[Status of Lightspeed Core Stack versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/version_status.html)
92+
[Database](https://lightspeed-core.github.io/lightspeed-stack/models/database.html)
9293

93-
[Supported versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/versions_supported.html)
94+
[Requests](https://lightspeed-core.github.io/lightspeed-stack/models/requests.html)
9495

95-
[Unsupported versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/versions_unsupported.html)
96+
[Successful responses](https://lightspeed-core.github.io/lightspeed-stack/models/responses_succ.html)
9697

97-
## Migration guides
98+
[Error responses](https://lightspeed-core.github.io/lightspeed-stack/models/responses_errors.html)
9899

99-
[Migration guides](https://lightspeed-core.github.io/lightspeed-stack/migrations/)
100+
[Compaction](https://lightspeed-core.github.io/lightspeed-stack/models/compaction.html)
100101

102+
### Testing
101103

102-
[Sentry error tracking](https://lightspeed-core.github.io/lightspeed-stack/sentry.html)
104+
[Testing](https://lightspeed-core.github.io/lightspeed-stack/testing.html)
103105

106+
[End-to-End Tests Guide](https://lightspeed-core.github.io/lightspeed-stack/e2e_testing.html)
104107

108+
[List of e2e scenarios](https://lightspeed-core.github.io/lightspeed-stack/e2e_scenarios.html)
105109

106-
## Models
110+
## Maintenance
107111

108-
[Common](https://lightspeed-core.github.io/lightspeed-stack/models/common.html)
112+
[Status of Lightspeed Core Stack versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/version_status.html)
109113

110-
[Database](https://lightspeed-core.github.io/lightspeed-stack/models/database.html)
114+
[Supported versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/versions_supported.html)
111115

112-
[Requests](https://lightspeed-core.github.io/lightspeed-stack/models/requests.html)
116+
[Unsupported versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/versions_unsupported.html)
113117

114-
[Successful responses](https://lightspeed-core.github.io/lightspeed-stack/models/responses_succ.html)
118+
[Migration guides](https://lightspeed-core.github.io/lightspeed-stack/migrations/)
115119

116-
[Error responses](https://lightspeed-core.github.io/lightspeed-stack/models/responses_errors.html)
120+
[Branching](https://lightspeed-core.github.io/lightspeed-stack/maintenance/branching.html)
117121

118-
[Compaction](https://lightspeed-core.github.io/lightspeed-stack/models/compaction.html)
122+
[Releasing](https://lightspeed-core.github.io/lightspeed-stack/maintenance/releasing.html)
119123

124+
[LTS process overview](https://lightspeed-core.github.io/lightspeed-stack/maintenance/lts_flow.html)
120125

121126
## Design documents
122127

@@ -168,22 +173,6 @@ product questions using backend LLM services, agents, and RAG databases.
168173

169174
[Design](https://lightspeed-core.github.io/lightspeed-stack/design/observability-opentelemetry/observability-opentelemetry.html)
170175

171-
## Testing
172-
173-
[Testing](https://lightspeed-core.github.io/lightspeed-stack/testing.html)
174-
175-
[End-to-End Tests Guide](https://lightspeed-core.github.io/lightspeed-stack/e2e_testing.html)
176-
177-
[List of e2e scenarios](https://lightspeed-core.github.io/lightspeed-stack/e2e_scenarios.html)
178-
179-
## Releasing
180-
181-
[Branching](https://lightspeed-core.github.io/lightspeed-stack/branching.html)
182-
183-
[Releasing](https://lightspeed-core.github.io/lightspeed-stack/releasing.html)
184-
185-
[LTS provess overview](https://lightspeed-core.github.io/lightspeed-stack/lts_flow.html)
186-
187176
## Demos
188177

189178
[LCORE introduction](https://lightspeed-core.github.io/lightspeed-stack/demos/lcore/lcore.html#/)
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,15 +157,15 @@ branch naming conventions are not covered here.
157157

158158
### Feature and fix branches that are merged into the main branch
159159

160-
[branching_1](https://lightspeed-core.github.io/lightspeed-stack/branching_1.svg)
160+
[branching_1](https://lightspeed-core.github.io/lightspeed-stack/maintenance/branching_1.svg)
161161

162162
### Cherry-picking changes into release (stable) branch from the main branch
163163

164-
[branching_2](https://lightspeed-core.github.io/lightspeed-stack/branching_2.svg)
164+
[branching_2](https://lightspeed-core.github.io/lightspeed-stack/maintenance/branching_2.svg)
165165

166166
### Multiple release branches, fixes made in fix branches
167167

168-
[branching_3](https://lightspeed-core.github.io/lightspeed-stack/branching_3.svg)
168+
[branching_3](https://lightspeed-core.github.io/lightspeed-stack/maintenance/branching_3.svg)
169169

170170

171171
## Branching strategy
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)