[Bug] Dockerhub repo and images need a description

[arun-gupta]

Priority

Undecided

OS type

Ubuntu

Hardware type

Xeon-GNR

Installation method

• Pull docker images from hub.docker.com
• Build docker images from source

Deploy method

• Docker compose
• Docker
• Kubernetes
• Helm

Running nodes

Single Node

What's the version?

latest

Description

Several updates are required for Docker Hub at https://hub.docker.com/u/opea:

• Add OPEA logo
• Add a top-level repo description, such that a proper text-based explanation is available. Today, it looks like

as opposed to [MongoDB's Atlas repo](https://hub.docker.com/r/mongodb/atlas): - Add a description for each image, currently, it looks pretty blank

Reproduce steps

As listed above

Raw log

No response

[chickenrae]

@ashahba Checking on progress here :)

[xiguiw]

@ashahba

This is important for user experience.
Any update, progress?

[ashahba]

@arun-gupta and everyone else, sorry for my delayed response on this issue.
It is certainly manageable for this release.
The good news is, this task is not a release gating one.

[ashahba]

Regarding this issue, I have been playing today with a GitHub action to publish descriptions and at least the CD part is working as expected.
The only problem is we need content for each description before passing them to the GHA.
For example I used this README: https://github.com/opea-project/GenAIExamples/blob/main/AudioQnA/README.md

to populate this image: https://hub.docker.com/r/ashahba/audioqna and which is identical to https://hub.docker.com/r/opea/audioqna

as you see reference style links are not converted properly which is a known issue and for that reason we need to review the descriptions or even maintain separate description files for each image.

Once the descriptions are in place, it's just the matter of adding the action the repo and do everything in a single run.

[ashahba]

The action I'm using is this one: https://github.com/peter-evans/dockerhub-description