diff options
| author | Nathaniel Kierpiec <nkierpiec@chef.io> | 2020-07-22 14:02:19 -0400 |
|---|---|---|
| committer | Tom Duffield <tom@chef.io> | 2020-07-28 10:53:20 -0500 |
| commit | 395f9f54cef1e3cb7333d4f875e4c97e9a7123b3 (patch) | |
| tree | 5a07826688d878ee1bf3d52acf34edea09e67c1d | |
| parent | 85233431888bdf7935f7ae9fe4c1b8a46c7384a1 (diff) | |
| download | chef-395f9f54cef1e3cb7333d4f875e4c97e9a7123b3.tar.gz | |
Remove README updates and move to a dev/how-to
Edit: TO test expeditor
Signed-off-by: Nathaniel Kierpiec <nkierpiec@chef.io>
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | docs/dev/README.md | 1 | ||||
| -rw-r--r-- | docs/dev/how_to/building_docker_images.md | 11 |
3 files changed, 12 insertions, 4 deletions
@@ -44,10 +44,6 @@ To learn more about our monthly feature releases and yearly major releases, see We'd love to have your help developing Chef Infra. See our [Contributing Document](./CONTRIBUTING.md) for more information on getting started. -## How to use [Dobi](https://dnephin.github.io/dobi/) - -For local development, uncomment the `.envrc` file and run `direnv reload`. Dobi will use those env variables for when you want to build the docker images locally. If you are already using `direnv` you can just add those env variables to whatever you are using or just export the env variables locally. - ## License and Copyright Copyright 2008-2020, Chef Software, Inc. diff --git a/docs/dev/README.md b/docs/dev/README.md index 20a756b1f4..0528285c42 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md @@ -10,6 +10,7 @@ A good first start is our [How Chef Infra Is Built](./design_documents/how_chef_ - [Branching and Backporting Changes](./how_to/branching_and_backporting.md) - [Updating Dependencies](./how_to/updating_dependencies.md) - [Bumping Major and Minor Versions](./how_to/bumping_minor_or_major_versions.md) +- [Building Docker Images](./how_to/building_docker_images.md) ## Design Documents diff --git a/docs/dev/how_to/building_docker_images.md b/docs/dev/how_to/building_docker_images.md new file mode 100644 index 0000000000..d751fe8466 --- /dev/null +++ b/docs/dev/how_to/building_docker_images.md @@ -0,0 +1,11 @@ +# Building Docker Images + +## Using [Dobi](https://dnephin.github.io/dobi/) + +If you are unfamiliar with Dobi, it is a build automation tool for Docker applications. You can check out a lot of what Dobi has to offer at the link above or [here](https://github.com/dnephin/dobi). + +### Local Development + +Uncomment the `.envrc` file and run `direnv reload`. Dobi will use those env variables through variable substitution when you want to build the docker images locally. If you are already using `direnv` you can just add those env variables to what you are using or just export the env variables locally. + +You can then run the specified task (if there are any) that you would like Dobi to do. Since there are not many build steps there is no need to specify robust tasks for Dobi here. All that is needed is simply to run `dobi chef` after exporting those env variables and Dobi will build, tag and push your image to your image registry.
\ No newline at end of file |