diff --git a/comps/chathistory/README.md b/comps/chathistory/README.md index 5ba529774b..84d9adb431 100644 --- a/comps/chathistory/README.md +++ b/comps/chathistory/README.md @@ -6,8 +6,6 @@ It can be integrated into application by making HTTP requests to the provided AP ![Flow Chart](./assets/img/chathistory_flow.png) ---- - ## 🛠️ Features - **Store Chat Conversations**: Save chat messages user information, and metadata associated with each conversation. @@ -15,12 +13,11 @@ It can be integrated into application by making HTTP requests to the provided AP - **Update Chat Conversations**: Modify existing chat conversations by adding new messages or updating existing ones. - **Delete Chat Conversations**: Remove chat conversations record from database. ---- - -## ⚙️ Implementation - -The Chat History microservice able to support various database backends for storing the chat conversations. +## ⚙️ Deployment Options -### Chat History with MongoDB +To get detailed, step-by-step instructions on deploying the `chathistory` microservice, you should consult the deployment guide. This guide will walk you through all the necessary steps, from building the Docker images to configuring your environment and running the service. -For more detail, please refer to this [README](src/README.md) +| Platform | Deployment Method | Database | Link | +| -------- | ----------------- | -------- | --------------------------------------------------------- | +| CPU | Docker | MongoDB | [Deployment Guide](./deployment/docker_compose/README.md) | +| CPU | Docker Compose | MongoDB | [Deployment Guide](./deployment/docker_compose/README.md) | diff --git a/comps/chathistory/src/README.md b/comps/chathistory/deployment/docker_compose/README.md similarity index 100% rename from comps/chathistory/src/README.md rename to comps/chathistory/deployment/docker_compose/README.md diff --git a/comps/feedback_management/README.md b/comps/feedback_management/README.md index 044b31d668..2bd0095451 100644 --- a/comps/feedback_management/README.md +++ b/comps/feedback_management/README.md @@ -2,8 +2,6 @@ The Feedback Management microservice facilitates the storage and retrieval of users'feedback data by establishing a connection with the databases. This microservice is designed to seamlessly integrate with OPEA applications, enabling data persistence and efficient management of feedback data. ---- - ## 🛠️ Features - **Store Feedback**: Save feedback data from user into database. @@ -11,12 +9,11 @@ The Feedback Management microservice facilitates the storage and retrieval of us - **Update Feedback**: Update feedback data info in the database based on id. - **Delete Feedback**: Remove feedback record from database. ---- - -## ⚙️ Implementation - -The Feedback Management microservice able to support various database backends for storing the feedback data. +## ⚙️ Deployment Options -### Feedback Management with MongoDB +To get detailed, step-by-step instructions on deploying the `feedback_management` microservice, you should consult the deployment guide. This guide will walk you through all the necessary steps, from building the Docker images to configuring your environment and running the service. -For more detail, please refer to this [README](./src/README.md) +| Platform | Deployment Method | Database | Link | +| -------- | ----------------- | -------- | --------------------------------------------------------- | +| CPU | Docker | MongoDB | [Deployment Guide](./deployment/docker_compose/README.md) | +| CPU | Docker Compose | MongoDB | [Deployment Guide](./deployment/docker_compose/README.md) | diff --git a/comps/feedback_management/src/README.md b/comps/feedback_management/deployment/docker_compose/README.md similarity index 100% rename from comps/feedback_management/src/README.md rename to comps/feedback_management/deployment/docker_compose/README.md diff --git a/comps/prompt_registry/README.md b/comps/prompt_registry/README.md index badbb88a4e..ae4989d155 100644 --- a/comps/prompt_registry/README.md +++ b/comps/prompt_registry/README.md @@ -2,20 +2,17 @@ The Prompt Registry microservice facilitates the storage and retrieval of users' preferred prompts by establishing a connection with the databases. This microservice is designed to seamlessly integrate with OPEA applications, enabling data persistence and efficient management of user's preferred prompts. ---- - ## 🛠️ Features - **Store Prompt**: Save user's preferred prompt into database. - **Retrieve Prompt**: Fetch prompt from database based on user, id or even a keyword search. - **Delete Prompt**: Remove prompt from database. ---- - -## ⚙️ Implementation - -The Prompt Registry microservice able to support various database backends for storing the prompts. +## ⚙️ Deployment Options -### Prompt Registry with MongoDB +To get detailed, step-by-step instructions on deploying the `prompt_registry` microservice, you should consult the deployment guide. This guide will walk you through all the necessary steps, from building the Docker images to configuring your environment and running the service. -For more detail, please refer to this [README](./src/README.md) +| Platform | Deployment Method | Database | Link | +| -------- | ----------------- | -------- | --------------------------------------------------------- | +| CPU | Docker | MongoDB | [Deployment Guide](./deployment/docker_compose/README.md) | +| CPU | Docker Compose | MongoDB | [Deployment Guide](./deployment/docker_compose/README.md) | diff --git a/comps/prompt_registry/src/README.md b/comps/prompt_registry/deployment/docker_compose/README.md similarity index 100% rename from comps/prompt_registry/src/README.md rename to comps/prompt_registry/deployment/docker_compose/README.md