AcademySoftwareFoundation / AcademySoftwareFoundation/aswf-docker
Improvements to individual README.mds?
- Dominant language
- Python
- Stars
- 189
- Forks
- 42
- Avg merge
- 9h 38m
- Merged PRs (30d)
- 6
Description
Currently the jinja2 template which generates the README.md for each container lists "packages + implicitpackages" as one undifferentiated list. Would it make sense to explicitly separate the list of what comes from this specific container build vs what comes from the lower level containers it derives from?
On a related note (and I may be misunderstanding the nature of the hierarchy), the packages from ci-common don't seem to get listed: it would seem to be useful for instance to know exactly which version of clang / cuda / ... is in a container.
Contributor guide
Research direction
Locate the Jinja2 template that generates each container's README.md and inspect how packages and implicitpackages are assembled across the container hierarchy. Determine how ci-common packages are represented, then define completion as README output that distinguishes container-specific packages from inherited packages and includes the relevant ci-common versions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, python
- Domain
- devops, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100