Skip to content

Update and simplify ChatQnA tutorials #345

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 15 commits into from
Apr 18, 2025

Conversation

alexsin368
Copy link
Collaborator

  • Remove steps to build images: just use docker compose to pull images instead
  • Remove outdated steps: some microservices do not need to be validated
  • Add NGINX setup and validation of microservice
  • Set host_ip to localhost: previously, using the external IP address causes no responses from the curl commands
  • Fix grammar and improve wording

Signed-off-by: alexsin368 <[email protected]>
Signed-off-by: alexsin368 <[email protected]>
@louie-tsai
Copy link
Contributor

@lvliang-intel @letonghan could you help to review the doc PR?

@yinghu5 yinghu5 self-requested a review April 9, 2025 07:25
Copy link
Collaborator

@yinghu5 yinghu5 left a comment

Choose a reason for hiding this comment

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

The "Expected Output" and "Summary and Next Steps" sections are marked as "TBD". Ensure these sections are completed with relevant content before finalizing the document. Hope we can remove the TBD in this update. thank you!

@alexsin368
Copy link
Collaborator Author

addressed comments from @yinghu5

Signed-off-by: alexsin368 <[email protected]>
Copy link
Collaborator

@yinghu5 yinghu5 left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

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.

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

Files not reviewed (1)
  • tutorial/ChatQnA/ChatQnA_Guide.rst: Language not supported

@joshuayao joshuayao added the documentation Improvements or additions to documentation label Apr 14, 2025
@mkbhanda
Copy link
Collaborator

@jedwards-habana would you please review

Copy link
Collaborator

@jedwards-habana jedwards-habana left a comment

Choose a reason for hiding this comment

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

Most of the suggested changes are grammatical and, while adding to the clarity of the document, are not critical. Otherwise the documents look good.
.
I didn't review the nvidia.md document. My suggested edit may apply to that document as well.

Signed-off-by: alexsin368 <[email protected]>
Copy link
Collaborator Author

@alexsin368 alexsin368 left a comment

Choose a reason for hiding this comment

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

addressed all of @jedwards-habana's comments to the Xeon, Gaudi, AIPC, and NVIDIA tutorials

Copy link
Collaborator

@jedwards-habana jedwards-habana left a comment

Choose a reason for hiding this comment

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

Suggested changes have been made. LGTM.

Signed-off-by: alexsin368 <[email protected]>
@hshen14 hshen14 merged commit 68bfc0a into opea-project:main Apr 18, 2025
4 checks passed
@github-project-automation github-project-automation bot moved this from In review to Done in OPEA Apr 18, 2025
@alexsin368 alexsin368 deleted the val_updates_chatqna branch April 22, 2025 00:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation v1.3
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

8 participants