[LCORE-1342] OKP Solr documentation#1169
Merged
tisnik merged 1 commit intolightspeed-core:mainfrom Feb 17, 2026
Merged
Conversation
Signed-off-by: Anxhela Coba <acoba@redhat.com>
Contributor
WalkthroughThis PR adds comprehensive documentation for Solr Vector IO as a read-only vector search provider to the RAG guide, including configuration examples and operational details, while disabling Solr in the default lightspeed-stack.yaml configuration. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/rag_guide.md (1)
297-304: Documentation example showsenabled: truewhile the default config sets it tofalse— add a note for clarity.The
lightspeed-stack.yamldefault now ships withenabled: false. The example here correctly showsenabled: true(since this is the "how to enable" section), but a brief sentence noting that Solr is disabled by default and must be explicitly enabled would help users avoid confusion.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/rag_guide.md` around lines 297 - 304, Add a brief clarifying sentence under the lightspeed-stack.yaml Solr example stating that Solr is disabled by default in the shipped configuration and must be explicitly enabled (set solr.enabled: true) to use Solr vector IO or offline mode; reference the lightspeed-stack.yaml example block and the solr.enabled field when inserting the note so readers understand this is an intentional override.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/rag_guide.md`:
- Around line 264-266: The Table of Contents is missing an entry for the new
"Solr Vector IO" subsection; update the existing ToC by adding a bullet like "*
[Solr Vector IO](`#solr-vector-io`)" under the other items so the "Solr Vector IO"
header links from the ToC and navigation stays consistent with the new section.
- Around line 320-321: The GitHub link in the Solr instruction is missing the
required ref segment (e.g., /blob/main/) and is therefore invalid; update the
URL string (the one pointing to lightspeed-providers ... README.md) to include
/blob/main/ between the repository and path so it matches the corrected form
(https://github.com/lightspeed-core/lightspeed-providers/blob/main/lightspeed_stack_providers/providers/remote/solr_vector_io/solr_vector_io/README.md).
---
Nitpick comments:
In `@docs/rag_guide.md`:
- Around line 297-304: Add a brief clarifying sentence under the
lightspeed-stack.yaml Solr example stating that Solr is disabled by default in
the shipped configuration and must be explicitly enabled (set solr.enabled:
true) to use Solr vector IO or offline mode; reference the lightspeed-stack.yaml
example block and the solr.enabled field when inserting the note so readers
understand this is an intentional override.
Comment on lines
+264
to
+266
| ### Solr Vector IO | ||
|
|
||
| The OKP (Offline Knowledge Portal) Solr Vector IO is a read-only vector search provider that integrates with Apache Solr for enhanced vector search capabilities. It enables retrieving contextual information from Solr-indexed Red Hat documents to enhance query responses with support for hybrid search and chunk window expansion. |
Contributor
There was a problem hiding this comment.
Table of Contents is missing an entry for the new Solr Vector IO section.
The ToC (lines 12–22) doesn't link to this new subsection. Consider adding an entry like * [Solr Vector IO](#solr-vector-io) under the existing items to keep navigation consistent.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/rag_guide.md` around lines 264 - 266, The Table of Contents is missing
an entry for the new "Solr Vector IO" subsection; update the existing ToC by
adding a bullet like "* [Solr Vector IO](`#solr-vector-io`)" under the other items
so the "Solr Vector IO" header links from the ToC and navigation stays
consistent with the new section.
Comment on lines
+320
to
+321
| - Solr must be running and accessible at the configured URL | ||
| for instructions on how to pull and run the OKP Solr image visit: https://github.com/lightspeed-core/lightspeed-providers/lightspeed_stack_providers/providers/remote/solr_vector_io/solr_vector_io/README.md |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, check if docs/rag_guide.md exists and read the relevant lines
if [ -f "docs/rag_guide.md" ]; then
echo "=== Lines 320-321 from docs/rag_guide.md ==="
sed -n '320,321p' docs/rag_guide.md
echo ""
echo "=== Context (lines 315-325) ==="
sed -n '315,325p' docs/rag_guide.md
else
echo "File docs/rag_guide.md not found"
fiRepository: lightspeed-core/lightspeed-stack
Length of output: 856
🏁 Script executed:
# Check if the solr_vector_io directory exists
fd -t d "solr_vector_io" . 2>/dev/null || echo "Directory not found via fd"
# Also check git ls-files for README files
echo "=== Searching for README files in lightspeed_stack_providers ==="
git ls-files | grep -i "lightspeed_stack_providers.*solr.*README" || echo "No matches found"
# List directory structure if it exists
if [ -d "lightspeed_stack_providers" ]; then
echo "=== lightspeed_stack_providers structure ==="
find lightspeed_stack_providers -type f -name "README*" 2>/dev/null | head -20
fiRepository: lightspeed-core/lightspeed-stack
Length of output: 157
🏁 Script executed:
# Test the corrected URL format
echo "=== Testing corrected GitHub URL format ==="
curl -s -I "https://github.com/lightspeed-core/lightspeed-providers/blob/main/lightspeed_stack_providers/providers/remote/solr_vector_io/solr_vector_io/README.md" | head -1
echo ""
echo "=== Testing original malformed URL ==="
curl -s -I "https://github.com/lightspeed-core/lightspeed-providers/lightspeed_stack_providers/providers/remote/solr_vector_io/solr_vector_io/README.md" | head -1
# Also check if the lightspeed-providers repo exists
echo ""
echo "=== Testing if lightspeed-providers repo exists ==="
curl -s -I "https://github.com/lightspeed-core/lightspeed-providers" | head -1Repository: lightspeed-core/lightspeed-stack
Length of output: 250
Broken GitHub URL — missing /blob/main/ segment.
The link in line 321 is syntactically invalid. GitHub URLs require a ref segment (/blob/main/, /blob/branch/, etc.) between the repository name and the file path. The current URL concatenates them directly.
Correct the URL to:
https://github.com/lightspeed-core/lightspeed-providers/blob/main/lightspeed_stack_providers/providers/remote/solr_vector_io/solr_vector_io/README.md
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/rag_guide.md` around lines 320 - 321, The GitHub link in the Solr
instruction is missing the required ref segment (e.g., /blob/main/) and is
therefore invalid; update the URL string (the one pointing to
lightspeed-providers ... README.md) to include /blob/main/ between the
repository and path so it matches the corrected form
(https://github.com/lightspeed-core/lightspeed-providers/blob/main/lightspeed_stack_providers/providers/remote/solr_vector_io/solr_vector_io/README.md).
19 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Initial documentation to help users onboard to using OKP Solr in lightspeed-core. Also, set Solr disabled by default.
Type of change
Tools used to create PR
Identify any AI code assistants used in this PR (for transparency and review context)
Related Tickets & Documents
Checklist before requesting a review
Testing
Summary by CodeRabbit
Documentation
Chores