InTheForest/moby
1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2026-01-11 18:51:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update contributing guides for clarity and consistency (#49891)

Browse Source 
Signed-off-by: Aditya Mishra <mishraaditya675@gmail.com>
This commit is contained in:
2003Aditya
2025-11-10 22:54:05 +05:30
committed by Aditya Mishra
parent 4dc87c55c7
commit 442f0115cd
3 changed files with 16 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/contributing/ctn-build.md
View File

@@ -1,7 +1,11 @@
The `Dockerfile` supports building and cross compiling docker daemon and extra
tools using [Docker Buildx](https://github.com/docker/buildx) and [BuildKit](https://github.com/moby/buildkit).
A [bake definition](https://docs.docker.com/build/bake/file-definition/) named
`docker-bake.hcl` is in place to ease the build process:
A [bake definition](https://docs.docker.com/build/bake/reference/) named
`docker-bake.hcl` is in place to ease the build process.
Section [development container](set-up-dev-env.md#work-with-a-development-container)
describes how to develop and compile your changes in a Linux container. You can also build
and cross-compile the binaries.
```shell
# build binaries for the current host platform

12
docs/contributing/set-up-dev-env.md
View File

@@ -137,6 +137,10 @@ can take over 15 minutes to complete.
Alternatively you can use the provided devcontainer in an IDE that supports them (VSCode, Goland, etc.)
> **Note:** The `make shell` command creates an image tagged as `docker-dev:latest` by default.
> It does not automatically tag the image with your current branch name, even if you are on a feature branch.
> Some older documentation or examples may refer to a branch-specific tag, but that behavior is no longer used.
5. List the contents of the current directory (`/go/src/github.com/docker/docker`).
You should see the image's source from the `/go/src/github.com/docker/docker`
@@ -212,13 +216,13 @@ can take over 15 minutes to complete.
Notice the split versions between client and server, which might be
unexpected. In more recent times the Docker CLI component (which provides the
`docker` command) has split out from the Moby project and is now maintained in [docker/cli](https://github.com/docker/cli).
The Moby project now defaults to a [fixed
version](https://github.com/docker/cli/commits/v17.06.0-ce) of the
`docker` CLI for integration tests.
You may have noticed the following message when starting the container with the `shell` command:
```none
Makefile:123: The docker client CLI has moved to github.com/docker/cli. For a dev-test cycle involving the CLI, run:
DOCKER_CLI_PATH=/host/path/to/cli/binary make shell
@@ -330,7 +334,7 @@ example, you'll edit the help for the `attach` subcommand.
8. Stop Docker if it is running.
9. Copy the binaries to **/usr/bin** by entering the following commands in the docker development container shell.
9. Copy the binaries to **/usr/local/bin** by entering the following commands in the docker development container shell.
```
hack/make.sh binary install-binary
@@ -361,4 +365,4 @@ Congratulations, you have successfully achieved Docker inception. You've had a
small experience of the development process. You've set up your development
environment and verified almost all the essential processes you need to
contribute. Of course, before you start contributing, [you'll need to learn one
more piece of the development process, the test framework](test.md).
more piece of the development process, the test framework](test.md).

5
docs/contributing/test.md
View File

@@ -7,8 +7,7 @@ about Moby's test infrastructure.
This section describes tests you can run in the `dry-run-test` branch of your Docker
fork. If you have followed along in this guide, you already have this branch.
If you don't have this branch, you can create it or simply use another of your
branches.
If you don't have this branch, you can create it or simply use another branch.
## Understand how to test Moby
@@ -240,7 +239,7 @@ make any changes, just run these commands again.
## [Public CI infrastructure](ci.docker.com/public)
The current infrastructure is maintained here: [Moby ci job](https://ci.docker.com/public/job/moby). The Jenkins infrastructure is for the Moby project is maintained and
The current infrastructure is maintained here: [Moby ci job](https://ci.docker.com/public/job/moby). The Jenkins infrastructure for the Moby project is maintained and
managed by Docker Inc. All contributions against the Jenkinsfile are
appreciated and welcomed! However we might not be able to fully provide the
infrastructure to test against various architectures in our CI pipelines. All