docker / docker/docker-py

Examples in low-level API documentation

Open
#3,060 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
7.2k
Forks
1.7k
Avg merge
13d 8h
Merged PRs (30d)
2

Description

In the low-level API docs, some examples are included at the moment. However, I find that for the containers section in particular, the examples are scarce and users would benefit from them. The few examples for containers (which are good, indeed) are restricted to:

  • create_container() (focused on using volumes and networking, See examples)
  • create_point_config() (See example)
  • create_host_config() (See example)
  • create_network_config (See example)
  • start() (See example)
  • get_archive() (See example)
  • port (See example)

Would it be possible to add more examples to the documentation? If there is any interest in a contribution to improve the docs, I'm happy to help.
IMO one fundamental piece missing in the overall docs is the lack of equivalence between the docker commands with their respective SDK. A table or cheat sheet for this would be extremely useful for users.

Contributor guide

Open the contributing guide

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 with the low-level API documentation and the containers section linked in the issue, then review the existing examples for create_container(), create_endpoint_config(), create_host_config(), create_networking_config(), start(), get_archive(), and port(). Define a focused set of additional container examples or a Docker command-to-SDK table, and consider the documentation complete when the selected workflows are demonstrated and the examples build or render correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.