Lack of Documentation
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 3.7k
- Forks
- 676
- Avg merge
- 4d 9h
- Merged PRs (30d)
- 6
Description
Even though most Docker documentation applies to Moby, I find that Docker Swarm Mode is fundamentally different than Swarmkit. An API for the swarm.sock obviously exists, but I don't know how to use it. It would be nice if there was documentation for doing so.
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 by comparing the existing Docker documentation with Swarmkit and investigating the swarm.sock API mentioned in the issue. Document how to use that API and clearly distinguish Swarmkit behavior from Docker Swarm Mode; the documentation should be sufficient for users who need to work with swarm.sock.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- api, devops, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100