overview/mapping of CLI, Dockerfile and compose.yml
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 4.7k
- Forks
- 8.5k
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 108
Description
Is this a docs issue?
- My issue is about the documentation content or website
Type of issue
Other
Description
It might be helpful to be provided an overview of how the CLI, Dockerfile and compose.yml maps onto each other. I.e. showing the alternative ways of using docker. How do you keep track of this already, and could this be used to that end?
Location
docks.docker.com
Suggestion
Perhaps make one or more diagrams, tables, etc. Could be dynamic to allow changes in the code or mapping over time, or to allow users of the docs to specify what they would translate into e.g. CLI, Dockerfile or compose.yml
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the documentation at docs.docker.com and review how the Docker CLI, Dockerfile, and compose.yml workflows are currently described. Map the existing usage paths and determine the scope of an overview using diagrams, tables, or another format. Done means the documentation clearly explains how these approaches relate and how users can translate between them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, docker-compose
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100