E4S-Project / E4S-Project/E4S-Project.github.io

Add descriptions to containers on DockerHub

Open
#11 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
6
Forks
9
PR merge metrics
No merged PRs in 30d

Description

Is there a reason that most of the E4S containers at dockerhub have an empty description/overview?

image

Speaking as a user, when I visit https://hub.docker.com/u/ecpe4s and see 107 different multi-GB docker containers where most/all have empty descriptions, it's very intimidating to find what I need. It's not even clear which of these actually contain full/partial E4S installs and which only contain precursors that can be used to build/install E4S. Even given my knowledge of E4S, looking only at dockerhub I was unable to identify the "best" docker container to recommend for UPC++ users on a Linux laptop without GPU support.

If the "best" E4S containers for end users are really 50+GB, then I think it would be valuable to provide a rich description of the contents and any system requirements. This would give the user confidence he's downloading something useful and not just wasting his time/data.

It's also notable that the vast majority of those 107 docker containers have not been updated in over a year; I'm guessing these are effectively "dead" and just left around for legacy reasons? It might also be valuable to partition the dockerhub account into one that contains only the full-featured containers maintained with the latest E4S installed (ie the "product" intended for end-users), and a separate dockerhub account that contains "everything else".

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the ecpe4s DockerHub account linked in the issue and inventory the existing containers, their contents, update dates, and intended users. Define which containers need descriptions and what system requirements they should document; completion would require agreed guidance for users and a decision on how to handle outdated or legacy images.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
devops, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.