docs: Update README for PostgreSQL / Cosmos DB Integration #1576
Conversation
This file contains 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
…zer Configurations in JSON Environment Variables
refactor: Group Azure Blob Storage and Form Recognizer Configurations in JSON Environment Variables
…urations in JSON Environment Variables
Configure Environment Variables for Database Connection PostgresSQL
fix: Readme update - Refactor: Group Azure Blob Storage and Form Recognizer Configurations in JSON Environment Variables
# Conflicts: # poetry.lock
feat: Load Respective Database Class Dynamically - either CosmosDB or PostgreSQL
fix: close connection and error handling
feat: Downmerge from azure samples main
fix: Reference is shown multiple times for every sentence in response
…tibility with existing deployments
fix: Set COSMOSDB as the default for missing DATABASE_TYPE to ensure compatibility with existing deployments
Fr4nc3
requested review from
Avijit-Microsoft,
Roopan-Microsoft and
Prajwal-Microsoft
as code owners
Coverage Report •
|
Prajwal-Microsoft
approved these changes
Dec 20, 2024
|
🎉 This PR is included in version 1.14.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Here is the completed PR description:
Purpose
This PR updates the
README.mdto reflect the newly added PostgreSQL integration feature for the CWYD solution. The update clarifies the differences between using Cosmos DB and PostgreSQL for chat history and search indexing, enabling customers to make informed choices aligned with their infrastructure strategies.Does this introduce a breaking change?
How to Test
Get the code:
git clone [repo-address] cd [repo-name] git checkout [branch-name] npm installVerify the updated README.md file includes:
Test the rendering of the markdown file locally or via the GitHub interface to ensure formatting consistency.
What to Check
Verify that the following are valid:
Other Information
This update ensures the README aligns with the features added to the solution, enabling customers and contributors to understand the PostgreSQL integration and deployment options effectively.