Skip to content

Refine documents for DBQnA#2034

Merged
chensuyue merged 3 commits into
mainfrom
ze-refine/DBQnA
Jun 10, 2025
Merged

Refine documents for DBQnA#2034
chensuyue merged 3 commits into
mainfrom
ze-refine/DBQnA

Conversation

@ZePan110
Copy link
Copy Markdown
Collaborator

@ZePan110 ZePan110 commented Jun 5, 2025

Description

Refine documents for DBQnA

Issues

#1679

Type of change

List the type of change like below. Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds new functionality)
  • Breaking change (fix or feature that would break existing design and interface)
  • Others (enhancement, documentation, validation, etc.)

Dependencies

List the newly introduced 3rd party dependency if exists.

Tests

Describe the tests that you ran to verify your changes.

Signed-off-by: ZePan110 <ze.pan@intel.com>
Copilot AI review requested due to automatic review settings June 5, 2025 05:22
@ZePan110 ZePan110 requested a review from lvliang-intel as a code owner June 5, 2025 05:22
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 5, 2025

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Files

None

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR refines documentation for the DBQnA deployment, updating README files for both Intel Xeon and AMD GPU (ROCm) platforms, and enhancing the overall clarity of deployment instructions.

  • Updated Intel Xeon README with a restructured quick start guide and clear step-by-step instructions.
  • Updated AMD GPU (ROCm) README with similar improvements in structure and detailed deployment steps.
  • Revised the main DBQnA README to include a table of contents and a deployment options table.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
DBQnA/docker_compose/intel/cpu/xeon/README.md Revised title, structured deployment steps, and simplified instructions.
DBQnA/docker_compose/amd/gpu/rocm/README.md Similar updates with enhanced clarity and explicit command examples.
DBQnA/README.md Added table of contents and deployment options table for clarity.
Comments suppressed due to low confidence (2)

DBQnA/docker_compose/amd/gpu/rocm/README.md:37

  • Consider removing or rephrasing the redundant sentence to avoid repetition since similar details are provided elsewhere in the document.
 Docker image creation, container deployment via Docker Compose, and service execution to integrate microservices. We will publish the Docker images to Docker Hub soon, which will simplify the deployment process for this service.

DBQnA/README.md:69

  • Consider capitalizing 'Rocm' as 'ROCm' for consistency with industry standards and with the rest of the document.
| AMD ROCm     | Docker compose    | [Deployment on AMD Rocm](./docker_compose/amd/gpu/rocm/README.md) |

@joshuayao joshuayao linked an issue Jun 6, 2025 that may be closed by this pull request
@chensuyue chensuyue merged commit ee068a0 into main Jun 10, 2025
13 checks passed
@chensuyue chensuyue deleted the ze-refine/DBQnA branch June 10, 2025 01:11
edlee123 pushed a commit to edlee123/GenAIExamples that referenced this pull request Jun 24, 2025
Signed-off-by: ZePan110 <ze.pan@intel.com>
Signed-off-by: Ed Lee <16417837+edlee123@users.noreply.github.com>
alexsin368 pushed a commit to alexsin368/GenAIExamples that referenced this pull request Aug 13, 2025
Signed-off-by: ZePan110 <ze.pan@intel.com>
Signed-off-by: alexsin368 <alex.sin@intel.com>
cogniware-devops pushed a commit to Cogniware-Inc/GenAIExamples that referenced this pull request Dec 19, 2025
Signed-off-by: ZePan110 <ze.pan@intel.com>
Signed-off-by: cogniware-devops <ambarish.desai@cogniware.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Doc] Refine the README for DBQnA

5 participants