Refine documents for DBQnA#2034
Merged
Merged
Conversation
Signed-off-by: ZePan110 <ze.pan@intel.com>
Dependency Review✅ No vulnerabilities or license issues found.Scanned FilesNone |
Contributor
There was a problem hiding this comment.
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) |
letonghan
approved these changes
Jun 6, 2025
Zhenzhong1
approved these changes
Jun 10, 2025
chensuyue
approved these changes
Jun 10, 2025
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>
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
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.
Description
Refine documents for DBQnA
Issues
#1679
Type of change
List the type of change like below. Please delete options that are not relevant.
Dependencies
List the newly introduced 3rd party dependency if exists.
Tests
Describe the tests that you ran to verify your changes.