LCORE-229: Create a deployment guide #357
Conversation
Signed-off-by: Anxhela Coba <acoba@redhat.com>
WalkthroughA new, comprehensive deployment guide for the Lightspeed Core Stack (LCS) was added, detailing multiple deployment methods and configurations. Simultaneously, the existing getting started guide was heavily simplified to focus only on local library-based deployment, removing container and advanced usage instructions. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Possibly related PRs
Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
docs/getting_started.md (1)
1-5: Heading level jumps from H1 to H3The very first subsection uses
###even though there is no##level heading in-between. This violates MD001 and looks odd in most renderers.-### Llama Stack used as a library +## Llama Stack used as a librarydocs/deployment_guide.md (4)
5-28: Unordered-list indentation/style is inconsistentThe manually-written TOC mixes two-space and four-space indents and alternates between
*and-. That triggers a large set of MD004 / MD007 warnings and makes the Markdown harder to maintain.Consider regenerating the TOC with a plugin (or at least normalising to a single indent level and bullet style).
Example:-* [Preface](#preface) -* [Deployment methods](#deployment-methods) +* [Preface](#preface) +* [Deployment methods](#deployment-methods) * [Integration with Llama Stack framework](#integration-with-llama-stack-framework) * [Llama Stack as a library](#llama-stack-as-a-library) * [Llama Stack as a server](#llama-stack-as-a-server)
110-114: Wordiness – “last but not least”Line 112 uses the phrase “last but not least”, which the LanguageTool style checker flags as verbose. A simpler alternative such as “finally” keeps the prose tighter.
1530-1535: Use “cannot” instead of “can not”“Cannot” is the common spelling; splitting it is only needed for emphasis.
Fixing it removes the LanguageTool warning.-... the standard port mapping can not be leveraged there ... +... the standard port mapping cannot be leveraged there ...
218-244: Add language identifiers to fenced code blocksSeveral fenced blocks (e.g. sample CLI output around lines 222, 408, 590, 1178) omit a language tag, triggering MD040.
Annotate them withtext(orbash,json, etc.) so syntax highlighting and linting work correctly.-```ascii +```text Using CPython 3.12.10 interpreter at: /usr/bin/python3Repeat for the other anonymous blocks.
Also applies to: 408-416, 590-598, 1174-1182
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/deployment_guide.md(1 hunks)docs/getting_started.md(6 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/getting_started.md
3-3: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
docs/deployment_guide.md
8-8: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
9-9: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
11-11: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
12-12: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
13-13: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
14-14: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
15-15: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
16-16: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
17-17: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
18-18: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
19-19: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
20-20: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
21-21: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
22-22: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
23-23: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
25-25: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
26-26: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
27-27: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
30-30: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
31-31: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
32-32: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
33-33: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
34-34: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
35-35: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
36-36: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
37-37: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
38-38: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
39-39: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
40-40: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
41-41: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
42-42: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
43-43: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
44-44: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
45-45: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
46-46: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
48-48: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
49-49: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
50-50: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
51-51: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
52-52: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
53-53: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
54-54: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
55-55: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
71-71: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
72-72: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
72-72: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
73-73: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
73-73: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
74-74: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
75-75: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
75-75: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
76-76: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
76-76: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
222-222: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
243-243: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
408-408: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
590-590: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
990-990: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
1178-1178: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🪛 LanguageTool
docs/deployment_guide.md
[style] ~112-~112: ‘last but not least’ might be wordy. Consider a shorter alternative.
Context: ...ally made changes and improvements. And last but not least, it is possible to trace, monitor and d...
(EN_WORDINESS_PREMIUM_LAST_BUT_NOT_LEAST)
[grammar] ~978-~978: Ensure spelling is correct
Context: ...* image is needed and no other packages nor tools need to be installed. ### Retr...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~1533-~1533: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...container and the standard port mapping can not be leveraged there. This configuration ...
(CAN_NOT_PREMIUM)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: e2e_tests
tisnik
changed the title
2 participants
Description
Extracted the library deployment section from getting_started.md into a new getting_started.md file. Renamed the original to deployment_guide.md.
Type of change
Related Tickets & Documents
Checklist before requesting a review
Testing
Summary by CodeRabbit