Fix the contribution guide flow
The contribution guide now has a unified flow: - who-written-for.md was more appropriately renamed getting-started.md and links to the file were updated. - The links in the different contribution docs were updated, and form a unified flow. see docs/contributing/README.md for the steps. - doc files were updated with links to the following step in the guide to form the unified flow. Signed-off-by: Snir Ilani <marcalath@gmail.com>
This commit is contained in:
parent
bb98acf375
commit
8bd4147946
11 changed files with 47 additions and 31 deletions
|
@ -1,10 +1,9 @@
|
|||
# Contribute to the Moby Project
|
||||
|
||||
Want to hack on the Moby Project? Awesome! We have a contributor's guide that explains
|
||||
[setting up a development environment and the contribution
|
||||
process](docs/contributing/).
|
||||
Want to hack on the Moby Project? Awesome! We have a [contributor's guide](docs/contributing/README.md) that explains the contribution
|
||||
process.
|
||||
|
||||
[![Contributors guide](docs/static_files/contribute.png)](docs/contributing/who-written-for.md)
|
||||
[![Contributors guide](docs/static_files/contribute.png)](docs/contributing/README.md)
|
||||
|
||||
This page contains information about reporting issues as well as some tips and
|
||||
guidelines useful to experienced open source contributors. Finally, make sure
|
||||
|
|
|
@ -1,11 +1,20 @@
|
|||
# Get set up for Moby development
|
||||
# Moby Contribution Guide
|
||||
|
||||
* [README first](who-written-for.md)
|
||||
* [Get the required software](software-required.md)
|
||||
* [Set up for development on Windows](software-req-win.md)
|
||||
* (Optional) [Configure project for IDE](set-up-ide.md)
|
||||
* [Configure Git for contributing](set-up-git.md)
|
||||
* [Work with a development container](set-up-dev-env.md)
|
||||
* [Containerized build and cross compilation](ctn-build.md)
|
||||
* [Run tests and test documentation](test.md)
|
||||
* [Debugging the daemon](debug.md)
|
||||
## About this Guide
|
||||
|
||||
The Moby Contribution Guide will take you through the steps for setting up the tools and environment needed for development, and start contributing to the Moby Project.
|
||||
|
||||
## Steps for Contributing
|
||||
|
||||
Follow these steps:
|
||||
|
||||
1. [Get started with Moby](getting-started.md)
|
||||
2. Get the required software:
|
||||
- [For Linux / macOS](software-required.md)
|
||||
- [For Windows](software-req-win.md)
|
||||
3. (Optional) [Configure IDE](set-up-ide.md)
|
||||
4. [Configure Git](set-up-git.md)
|
||||
5. [Work with a Development Container](set-up-dev-env.md)
|
||||
6. [Containerized build and Cross compilation](ctn-build.md)
|
||||
7. [Run tests and test documentation](test.md)
|
||||
8. [Debugging the daemon](debug.md)
|
||||
|
|
|
@ -3,7 +3,7 @@
|
|||
The contributions described below are advanced because they use complex workflows or require more experience.
|
||||
If you like the challenge, this is the place for you.
|
||||
|
||||
By now you should have worked through the [previous parts](README.md) of the project contributing guide, and also [made at least one contribution](who-written-for.md).
|
||||
By now you should have worked through the [previous parts](README.md) of the project contributing guide, and also [made at least one contribution](getting-started.md).
|
||||
|
||||
## About the Advanced Contribution Process
|
||||
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
# Containerized Build and Cross Compilation
|
||||
|
||||
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
|
||||
|
@ -26,3 +28,7 @@ docker buildx bake binary-cross
|
|||
# build binaries for a specific platform
|
||||
docker buildx bake --set *.platform=linux/arm64
|
||||
```
|
||||
|
||||
## Where to go next
|
||||
|
||||
Next, check out [the test framework](test.md).
|
|
@ -60,7 +60,9 @@ outside the developer's machine and is not recommended.
|
|||
The Docker daemon will continue execution inside the container and debugger will stop it on the breakpoints.
|
||||
![GoLand - run Go Remote configuration](images/goland_run_debug_config.png)
|
||||
|
||||
## Where to go next
|
||||
## Next steps
|
||||
|
||||
Congratulations, you have experienced how to use Delve to debug the Docker daemon
|
||||
and how to configure an IDE to make use of it.
|
||||
|
||||
You're welcome to check out our [issue section on GitHub](https://github.com/moby/moby/issues) and start contributing.
|
|
@ -361,8 +361,9 @@ change, you might repeat or iterate through this flow several times.
|
|||
|
||||
## Where to go next
|
||||
|
||||
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).
|
||||
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.
|
||||
|
||||
For information about the containerized build and cross compilation [check out this part of the guide](ctn-build.md).
|
||||
|
||||
Else, before you start contributing, you'll need to learn one
|
||||
more piece of the development process, [the test framework](test.md).
|
|
@ -275,6 +275,4 @@ commit is signed.
|
|||
|
||||
## Where to go next
|
||||
|
||||
Congratulations, you have finished configuring both your local host environment
|
||||
and Git for contributing. In the next section you'll [learn how to set up and
|
||||
work in a Moby development container](set-up-dev-env.md).
|
||||
Congratulations, you have finished configuring both your local host environment and Git for contributing. In the next section you'll [learn how to set up and work in a Moby development container](set-up-dev-env.md).
|
||||
|
|
|
@ -33,4 +33,5 @@ it has to be configured in the settings as well:
|
|||
## Where to go next
|
||||
|
||||
Congratulations, you have finished configuring project to work with the IDE.
|
||||
In the next section you'll [learn how to set up and work in a Moby development container](set-up-dev-env.md).
|
||||
|
||||
In the next section you'll [learn how to set up and configure Git for contributing to Moby](set-up-git.md).
|
||||
|
|
|
@ -173,7 +173,7 @@ https://github.com/kevpar/docker-w2wCIScripts/blob/master/runCI/Invoke-DockerCI.
|
|||
|
||||
## Where to go next
|
||||
|
||||
In the next section, you'll [configure the project to be properly recognized by the IDE](set-up-ide.md).
|
||||
Optionally, you can [configure the project to be properly recognized by the IDE](set-up-ide.md).
|
||||
|
||||
If you don't want to use IDE, you can proceed to the next step
|
||||
If you don't want to use an IDE, you can proceed to the next step
|
||||
and [learn how to set up and configure Git for contributing to Moby](set-up-git.md).
|
|
@ -89,7 +89,7 @@ You must log out and log back in for this modification to take effect.
|
|||
|
||||
## Where to go next
|
||||
|
||||
In the next section, you'll [configure the project to be properly recognized by the IDE](set-up-ide.md).
|
||||
Optionally, you can [configure the project to be properly recognized by the IDE](set-up-ide.md).
|
||||
|
||||
If you don't want to use IDE, you can proceed to the next step
|
||||
If you don't want to use an IDE, you can proceed to the next step
|
||||
and [learn how to set up and configure Git for contributing to Moby](set-up-git.md).
|
Loading…
Reference in a new issue