From eff0acb4fe992f8b7ea919381da6496936aa39c9 Mon Sep 17 00:00:00 2001 From: Tung Bui Date: Thu, 29 Feb 2024 22:50:51 +0700 Subject: [PATCH 1/3] doc: enhancement --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 81502cb..00e66f6 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Before you begin, make sure you have [Docker](https://docs.docker.com/engine/install/) installed. It's also beneficial to have a basic understanding of Docker concepts. -## How to Build +## Build your own image **1. Clone the Repository:** @@ -55,7 +55,23 @@ docker build \ -t devops-toolkit:custom . ``` -**4. Run the toolkit image:** +**4. Test the toolkit image: ** + +- Run below command to verify newly created image + +```bash +cd scripts +chmod +x check_version_in_toolkit.sh +.check_version_in_toolkit.sh devops-toolkit:latest +``` + +## Use the official image from Docker Hub + +- To be implemented via release proccess + +## Use the toolkit image + +One we have the image ready, let's play with it! - Start toolkit container @@ -75,22 +91,6 @@ docker run --rm devops-toolkit:latest python3 --version docker run --rm devops-toolkit:latest python3 --version ``` - - -## Use the image from Docker Hub - -- To be implemented - -## Test the toolkit image - -Run below command to verify newly created image - -```bash -cd scripts -chmod +x check_version_in_toolkit.sh -.check_version_in_toolkit.sh devops-toolkit:latest -``` - ## The DevOps Toolkit Core Built on `ubuntu:22.04` base image From 97249a6c78c1e69553ba8579c99c3026189544f9 Mon Sep 17 00:00:00 2001 From: Tung Bui Date: Thu, 29 Feb 2024 22:53:12 +0700 Subject: [PATCH 2/3] doc: enhancement.v1 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 00e66f6..f813e17 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@ Before you begin, make sure you have [Docker](https://docs.docker.com/engine/ins ## Build your own image +NOTE: If you'd refer using the official prebuilt docker image from DockerHub, you can skip this section! + **1. Clone the Repository:** ```bash From 2ec2382e4aa34375665a8df5ff72c478195723a4 Mon Sep 17 00:00:00 2001 From: Tung Bui Date: Thu, 29 Feb 2024 22:54:18 +0700 Subject: [PATCH 3/3] doc: enhancement.v2 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f813e17..5d95950 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ docker build \ -t devops-toolkit:custom . ``` -**4. Test the toolkit image: ** +**4. Test the toolkit image:** - Run below command to verify newly created image