[Doc] The ChatQnA Readme for customizing UI front end service may be incomplete

[mkbhanda]

Priority

P4-Low

OS type

Ubuntu

Hardware type

Xeon-GNR

Installation method

• [X] Pull docker images from hub.docker.com
• [ ] Build docker images from source

Deploy method

• [X] Docker compose
• [ ] Docker
• [ ] Kubernetes
• [ ] Helm

Running nodes

Single Node

What's the version?

V 1.0 using images from docker hub.

Description

https://github.com/opea-project/GenAIExamples/tree/main/ChatQnA/docker_compose/intel/cpu/xeon We provide instructions to change out the simple curl call with a conversational UI. The instructions require more than simple cut and paste/replace in the compose file because the instructions mention fewer environment variables and veer off from using the $ENV variables in the original compose file.

Our getting started ChatQnA guide while rich in other ways such as capturing metrics appears to skip this customization instruction in https://opea-project.github.io/1.0/GenAIExamples/ChatQnA/README.html

Also need to remind using to modify the Nginx dependency from ui to conversation-ui ..

Reproduce steps

Just view and follow along the instructions in Readme.md

Raw log

No response

[surfiniaburger]

Hi @mkbhanda! I made a draft on this at https://docs.google.com/document/d/1MPPpFC9WYpR1c6LGjWLLWB_cut8Bi5-AhEtm76x8K0U/edit?usp=sharing. Can I be assigned this issue? I would love to know what steps I could take to make it fit the description you have outlined.

[mkbhanda]

Thank you @surfiniaburger for self assigning!! I looked at your google docs link and appreciate your careful analysis of the situation. I like how you suggest making a backup first of the compose file. Would you kindly consider making a script "use_conversation_ui.sh" or a name you prefer that just does all the relevant changes to reduce human error and add a test in chatQnA that alerts that the script may be broken if any of those environment variables change (endpoints, ports ..). This is our flagship example and worth keeping in ship shape.

[xiguiw]

Hi @mkbhanda! I made a draft on this at https://docs.google.com/document/d/1MPPpFC9WYpR1c6LGjWLLWB_cut8Bi5-AhEtm76x8K0U/edit?usp=sharing. Can I be assigned this issue? I would love to know what steps I could take to make it fit the description you have outlined.

@surfiniaburger Would you please submit PR to contribute this?

[surfiniaburger]

I made a draft PR on the issue. Details are listed within

[mkbhanda]

@surfiniaburger, typical process is to 1) fork the repository, 2) clone your fork, 3) create a branch, 4) modify the readme file there-in, 5) commit it with signoff, 6) then push to your fork, and 7)from your fork submit a PR to OPEA. I am laughing (or groaning) .. that is a lot of steps! Doing so would follow the standard pattern and allow others too to comment easily. we have line numbers, in-line comments and suggestions that you can harvest with a click. See https://github.com/firstcontributions/first-contributions. Seeing the PR old next to new makes for easier review.

[surfiniaburger]

My sincerest apologies. Going through the step you recommended here is the link to the PR. https://github.com/opea-project/GenAIExamples/pull/1672

[yinghu5]

@surfiniaburger , thank you a lot for create the PR, the status is still draft, would you like to drive to formal PR? [Remind]

[surfiniaburger]

@yinghu5 I've adjusted the status. 🙏

[yinghu5]

Hi @mkbhanda @surfiniaburger, Thank you very much for your dicussion, PR and contribution! As the corresponding README was updated in latest versoin and compose files based on the issue and the inconsistency between the README and the actual service startup process has been resolved. so i go ahead to close the issues, please feel free to share your ideas for better OPEA escosystem, thank you!