[cmd/builder] OCB DockerHub page does not have "overview"

[jackgopack4]

The OpenTelemetry Collector Builder DockerHub page does not have an "overview".

This would make it easier for users to read more about how to install and configure these docker images.

I know this is supposed to be automatically linked to the README.md if the repository/docker push command is set up correctly; there should be a way to do this in goreleaser.

[mowies]

Actually, none of the distros have an overview 😅

[mowies]

The dockerhub config settings from GoReleaser should do the trick: https://goreleaser.com/customization/dockerhub/

[mowies]

I guess for otelcol core and otelcol contrib we should the readmes from the respective repos cus those are more extensive and descriptive. For the otlp and k8s distro i think it's fine to use the distro-specific readme files for now.

[mowies]

@jackgopack4 do you have any suggestions for the short image descriptions for the otelcol distros?
They have a max of 100 chars, otherwise I would have just taken the first description line of the collector-core readme but that's too long.
It can probably also be one general description for all distros.

[jackgopack4]

If it's limited to 100 chars, will a link to the readme.md work?

[jackgopack4]

The character limit must be a Goreleaser limitation because I see plenty of examples of long descriptions

https://hub.docker.com/_/memcached

https://hub.docker.com/_/nginx

[mowies]

Ah no, wait i didn't explain myself fully.

There's 2 types of description:

• full description/overview -> basically a readme file (red) (i will use the readme files for that)
• description -> max 100 chars, used by e.g. docker search, basically a oneliner (purple)

[jackgopack4]

Oh wait you're talking for the individual tags themselves? I was only thinking we needed a description on the opentelemetry collector dockerhub page

OK I hadn't seen your response before posting again, makes sense

[mowies]

There one such page per image repository, so it's not per tag but per image (i.e. distro) that we have.

[mowies]

@jackgopack4 the PR should be ready for review minus the short descriptions. But those can also be done as a follow up. It's still a win if we get the readme files as the long descriptions.