moby / moby/libnetwork

Please state clearly in README whether this project is limited to docker, and/or has docker as a dependency

Open
#1,250 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
2.2k
Forks
875
PR merge metrics
No merged PRs in 30d

Description

The README is a bit ambiguous about whether this project can be used easily for other container handling software outside of docker.

At the top of the README it says:

Docker Networking

.. which suggests the project is strongly tied to and possibly depending on docker to work.

However, in design.md it says:

libnetwork project will follow Docker and Linux philosophy of developing small, highly modular and composable tools that work well independently. Libnetwork aims to satisfy that composable need for Networking in Containers.

.. which suggests it is independent or at least meant to be for the future.

Therefore, please state clearly in README whether this project is limited to use with/for docker, and whether it has docker as a required hard dependency when using it. Also if it is an independent project, please change the GitHub short description for the project from "Docker Networking" to something like "Container Networking for use by Docker and possibly other container engines" to make this more clear (and possibly add an explicit note about the possible independent use to the README too)

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

Read the README and design.md passages cited in the issue, then compare them with the GitHub short description. Done means the README clearly states whether Docker is required and whether independent use is supported, with the short description updated if appropriate.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.