Add short descriptions to the images OPEA publishes on Docker Hub #1637
Conversation
Dependency Review✅ No vulnerabilities or license issues found.Scanned Files
|
|
pls fix preci failure @zhanmyz |
|
Let me know if you need more discussion or inputs from my side. |
|
Hope we can finish this PR by v1.3 release. |
|
Hi @zhanmyz , thank you a lot for the contribution. Just remind please help check the comments |
2. Update the trigger strategy of dockerhub description from on push to schedule weekly
There was a problem hiding this comment.
In general the README.md files may contain relative hyperlinks that will not resolve properly when clicked from Dockerhub since the relative path is on GitHub, but I think this is already a great start and we can fix those in a subsequent PR.
Once the tests pass, we should get this merged and then focus on improvements.
LGTM.
|
hyperlink issue due to the code change of |
|
pre-commit.ci issue means your new workflow miss the license header. |
|
This should be the first PR for test, after this PR merged. We should optimize the PR with strategy for loop to reduce the maintain effort. |
for more information, see https://pre-commit.ci
|
The test failed with this workflow, https://github.com/opea-project/GenAIExamples/actions/runs/14190166423/job/39752841551 |
| username: ${{ secrets.DOCKERHUB_USER }} | ||
| password: ${{ secrets.DOCKERHUB_TOKEN }} | ||
| repository: opea/audioqna | ||
| short-description: "The docker image served as an audioqna gateway and using language modeling to generate answers to user queries by converting audio input to text, and then using text-to-speech (TTS) to convert those answers back to speech for interaction." |
There was a problem hiding this comment.
These descriptions are for DockerHub, they do not need to mention they are docker images, that's already known.
And past tense (served, acted, powered, exposed) sounds really odd in these description. Don't those images work anymore?
Something like this would be more to the point for all of these descriptions:
AudioQnA gateway. Uses language modeling to interact with the user, first by converting audio input queries to text, and then using text-to-speech (TTS) to convert those answers back to speech.
…ea-project#1637) Signed-off-by: zhanmyz <yazhan.ma@intel.com> Signed-off-by: Chingis Yundunov <c.yundunov@datamonsters.com>
Description
Add the description of the image in the repository GenAIComps and GenAIExamples to the corresponding Docker Hub with the recommended dockerhub-description tool
Issues
Fixes opea-project/docs#316
Type of change
List the type of change like below. Please delete options that are not relevant.
Dependencies
N/A
Tests
Describe the tests that you ran to verify your changes.