MAIT-119: Add SharePoint connector config and docs#28
Open
Conversation
📝 WalkthroughSummary by CodeRabbit
WalkthroughAdded SharePoint connector configuration examples to three files: environment variable definitions in Changes
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 262-281: The README shows a second connector named "sharepoint2"
but the .env.rag snippet only defines SHAREPOINT1_* variables; update the docs
to either add matching SHAREPOINT2_* placeholders (SHAREPOINT2_CLIENT_ID,
SHAREPOINT2_CLIENT_SECRET, SHAREPOINT2_TENANT_ID, SHAREPOINT2_SCHEDULES) in the
env example to align with the sharepoint2 config, or add a clear note near the
.env.rag snippet stating it demonstrates only SHAREPOINT1 and additional
connectors like sharepoint2 require analogous SHAREPOINT2_* entries; reference
the "sharepoint2" connector name and the SHAREPOINT2_* variable names so readers
can find and fix the mismatch.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 14495ba8-65de-4a3a-9763-9671f829aafa
📒 Files selected for processing (3)
.env.rag.exampleREADME.mdconfig.yaml.example
Comment on lines
+262
to
+281
| # Loading SharePoint site pages | ||
| - type: "sharepoint" | ||
| name: "sharepoint2" | ||
| config: | ||
| client_id: "${SHAREPOINT2_CLIENT_ID}" | ||
| client_secret: "${SHAREPOINT2_CLIENT_SECRET}" | ||
| tenant_id: "${SHAREPOINT2_TENANT_ID}" | ||
| sharepoint_site_name: "TeamSite" | ||
| sharepoint_type: "page" | ||
| schedules: "${SHAREPOINT2_SCHEDULES}" | ||
| ``` | ||
|
|
||
| ```dotenv | ||
| # .env.rag | ||
|
|
||
| SHAREPOINT1_CLIENT_ID=your-azure-app-client-id | ||
| SHAREPOINT1_CLIENT_SECRET=your-azure-app-client-secret | ||
| SHAREPOINT1_TENANT_ID=your-azure-tenant-id | ||
| SHAREPOINT1_SCHEDULES=3600 | ||
| ``` |
There was a problem hiding this comment.
Align env snippet with the second connector example.
This section introduces sharepoint2 config but the .env.rag snippet only shows SHAREPOINT1_*. Please either add SHAREPOINT2_* placeholders or explicitly state the snippet is single-connector only.
📘 Suggested doc patch
SHAREPOINT1_CLIENT_ID=your-azure-app-client-id
SHAREPOINT1_CLIENT_SECRET=your-azure-app-client-secret
SHAREPOINT1_TENANT_ID=your-azure-tenant-id
SHAREPOINT1_SCHEDULES=3600
+# Optional second SharePoint connector
+# SHAREPOINT2_CLIENT_ID=your-azure-app-client-id-2
+# SHAREPOINT2_CLIENT_SECRET=your-azure-app-client-secret-2
+# SHAREPOINT2_TENANT_ID=your-azure-tenant-id-2
+# SHAREPOINT2_SCHEDULES=3600📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| # Loading SharePoint site pages | |
| - type: "sharepoint" | |
| name: "sharepoint2" | |
| config: | |
| client_id: "${SHAREPOINT2_CLIENT_ID}" | |
| client_secret: "${SHAREPOINT2_CLIENT_SECRET}" | |
| tenant_id: "${SHAREPOINT2_TENANT_ID}" | |
| sharepoint_site_name: "TeamSite" | |
| sharepoint_type: "page" | |
| schedules: "${SHAREPOINT2_SCHEDULES}" | |
| ``` | |
| ```dotenv | |
| # .env.rag | |
| SHAREPOINT1_CLIENT_ID=your-azure-app-client-id | |
| SHAREPOINT1_CLIENT_SECRET=your-azure-app-client-secret | |
| SHAREPOINT1_TENANT_ID=your-azure-tenant-id | |
| SHAREPOINT1_SCHEDULES=3600 | |
| ``` |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 262 - 281, The README shows a second connector named
"sharepoint2" but the .env.rag snippet only defines SHAREPOINT1_* variables;
update the docs to either add matching SHAREPOINT2_* placeholders
(SHAREPOINT2_CLIENT_ID, SHAREPOINT2_CLIENT_SECRET, SHAREPOINT2_TENANT_ID,
SHAREPOINT2_SCHEDULES) in the env example to align with the sharepoint2 config,
or add a clear note near the .env.rag snippet stating it demonstrates only
SHAREPOINT1 and additional connectors like sharepoint2 require analogous
SHAREPOINT2_* entries; reference the "sharepoint2" connector name and the
SHAREPOINT2_* variable names so readers can find and fix the mismatch.
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
1 participant
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.
Summary
config.yamlconfig.yaml.exampleand.env.rag.exampleRelated
WikiTeq/rag-of-all-trades#41