Skip to content

Refine documents for DBQnA #2034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 10, 2025
Merged

Refine documents for DBQnA #2034

merged 3 commits into from
Jun 10, 2025

Conversation

ZePan110
Copy link
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 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
Copy link

github-actions bot commented Jun 5, 2025

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Files

None

Copy link
Contributor

@Copilot 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
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
4 participants