From 0eb27080c099d2033104047b2da60ab1a96c2b5d Mon Sep 17 00:00:00 2001 From: 9112Michael Date: Tue, 8 Oct 2019 13:10:09 -0700 Subject: [PATCH 1/3] Fixed typos and syntax to improve readablity --- Networking/README.md | 2 +- README.md | 10 +++++----- dockerFile-Basics/Chapter 1 - FROM & RUN.md | 4 ++-- dockerFile-Basics/Chapter 2 - CMD.md | 2 +- dockerFile-Basics/Chapter 3 - COPY.md | 2 +- dockerFile-Basics/Chapter 4 - ADD | 2 +- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/Networking/README.md b/Networking/README.md index bfaee51..ba7c3fe 100644 --- a/Networking/README.md +++ b/Networking/README.md @@ -3,7 +3,7 @@ # Understanding Expose -To expose the port number of container to the physical host. The physical host will b e connected to the internal port of the container. The application will be running on the container +To expose the port number of container to the physical host. The physical host will be connected to the internal port of the container. The application will be running on the container diff --git a/README.md b/README.md index 6238ff8..2433490 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,23 @@ # LearnDocker -This repository walks your through the basics to learn the basics of using docker. +This repository will teach you the basics of using docker. # CONTRIBUTING ### Contributing Guidelines! - Read this space to know the contributing guidelines. Please follow the guidelines for smooth contribution. Following the guidelines reflect your courtesy towards the open source contribution. The issues, potential changes and pull requests will be addressed in compliance with the quality of need and urgency. + Read this space to know the contributing guidelines. Please follow the guidelines to ensure that your contribution is considered. Following the guidelines reflects your respect towards the open source contribution. The issues, potential changes and pull requests will be addressed in compliance with the quality of need and urgency. ### Expected Contribution: -In case you are willing to contribute in any form, You're most Welcome! Improvement in documentation, reporting bugs and mistakes is expected in general. +You are welcome to contribute! Improvements to documentation, reporting bugs and mistakes is expected in general. # Getting started ## Ground Rules -Issues should be created to submit a change to the repository before opening a pull request. Communication in any form except the repository channels is not expected and will not be entertained. +Before opening a pull request, Issues should be created before submitting a change to the repository. Communication in any form except the repository channels is not expected and will not be entertained. # Your First Contribution -In case you have additions to the concepts, codebase, or anything relevant, You're most welcome to open an issue, followed by opening a pull request. You are again welcome to report a mistake in the existing content, and code obselete issues. +In case you have additions to the concepts, codebase, or anything relevant, you're most welcome to open an issue, followed by opening a pull request. You are again welcome to report a mistake in the existing content, and code obsolete issues. ### Know More about open Source Contributions: diff --git a/dockerFile-Basics/Chapter 1 - FROM & RUN.md b/dockerFile-Basics/Chapter 1 - FROM & RUN.md index 2fe95eb..ce27748 100644 --- a/dockerFile-Basics/Chapter 1 - FROM & RUN.md +++ b/dockerFile-Basics/Chapter 1 - FROM & RUN.md @@ -60,9 +60,9 @@ Since the underlying image is ubuntu, We want the packages updated and want to i RUN apt- get update && apt-get install tree: -This will be executed using two different layers but the good practice is to use as fewer layers as possible. +This will be executed using two different layers but the best practice is to use as fewer layers as possible. -Now ubuntu has been created as a base image and using the cache, the update has bee done and the tree has been installed on the instance of the running container. +Now ubuntu has been created as a base image and using the cache, the update has been done and the tree has been installed on the instance of the running container. While the instance of the container is running type in: diff --git a/dockerFile-Basics/Chapter 2 - CMD.md b/dockerFile-Basics/Chapter 2 - CMD.md index 97c6e51..fcb8223 100644 --- a/dockerFile-Basics/Chapter 2 - CMD.md +++ b/dockerFile-Basics/Chapter 2 - CMD.md @@ -24,7 +24,7 @@ CMD echo "I am Learning Docker and Running a container" ``` -Now, the echo statement is printed. To run multiple instructions, come to docker file in your cmd command put a semicolon at the end of the first command the write the second command +Now, the echo statement is printed. To run multiple instructions, come to docker file in your cmd command put a semicolon at the end of the first command then write the second command **E.g.** diff --git a/dockerFile-Basics/Chapter 3 - COPY.md b/dockerFile-Basics/Chapter 3 - COPY.md index 9a4d3b3..4383789 100644 --- a/dockerFile-Basics/Chapter 3 - COPY.md +++ b/dockerFile-Basics/Chapter 3 - COPY.md @@ -27,7 +27,7 @@ docker run -it --rm copy_docker ``` -To copy flas_apps folder from local machine to root folder of container with the same name. +To copy flask_apps folder from local machine to root folder of container with the same name. After the Container is started diff --git a/dockerFile-Basics/Chapter 4 - ADD b/dockerFile-Basics/Chapter 4 - ADD index 7e0d8d9..d5fca96 100644 --- a/dockerFile-Basics/Chapter 4 - ADD +++ b/dockerFile-Basics/Chapter 4 - ADD @@ -31,4 +31,4 @@ Run in Interactive Mode: docker run --rm add_docker ls/root/Harsh_apps/ to see In place of “Harsh_apps.tar.gz”, a URL can also be given. -It is not recommended, the best practices it to use wget or curl and then move it to the required destination, Go with RUN to use wget and extract things. +It is not recommended, the best practices is to use wget or curl and then move it to the required destination, Go with RUN to use wget and extract things. From 5e464773469ec4c2de184b9ce4ab2e5ddde3857c Mon Sep 17 00:00:00 2001 From: 9112Michael Date: Tue, 8 Oct 2019 14:01:23 -0700 Subject: [PATCH 2/3] Update Networking README.md --- Networking/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Networking/README.md b/Networking/README.md index ba7c3fe..284915f 100644 --- a/Networking/README.md +++ b/Networking/README.md @@ -29,7 +29,7 @@ To expose the port number of container to the physical host. The physical host w Create a network in host to run the container. -The idea is to have the range of IP address so that they can be assigned to the containers. For this CIDR will be used. CIDR is Classless Inter Domain Routing. A private subnet will be created. +The idea is to have a range of IP addresses so that they can be assigned to the containers. For this CIDR will be used. CIDR is Classless Inter Domain Routing. A private subnet will be created. From 7918489d4b1218bdd74b002dd79797b9a02b35a3 Mon Sep 17 00:00:00 2001 From: 9112Michael Date: Wed, 9 Oct 2019 09:36:54 -0700 Subject: [PATCH 3/3] Update Documentation --- dockerFile-Basics/Chapter 2 - CMD.md | 2 +- dockerFile-Basics/Chapter 3 - COPY.md | 2 +- dockerFile-Basics/Chapter 4 - ADD | 5 +++-- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/dockerFile-Basics/Chapter 2 - CMD.md b/dockerFile-Basics/Chapter 2 - CMD.md index fcb8223..74d3bd4 100644 --- a/dockerFile-Basics/Chapter 2 - CMD.md +++ b/dockerFile-Basics/Chapter 2 - CMD.md @@ -1,6 +1,6 @@ # UNDERSTANDING CMD -Instructs the docker that as soon as this docker starts, execute the set of commands following CMD. Basically, whatever under CMD will be executed as soon as the container starts +Instructs the docker that as soon as this docker starts, execute the set of commands following CMD. Basically, whatever under CMD will be executed as soon as the container starts **Steps To Follow:** diff --git a/dockerFile-Basics/Chapter 3 - COPY.md b/dockerFile-Basics/Chapter 3 - COPY.md index 4383789..2a8dc78 100644 --- a/dockerFile-Basics/Chapter 3 - COPY.md +++ b/dockerFile-Basics/Chapter 3 - COPY.md @@ -1,6 +1,6 @@ # Understanding COPY: -Command copy copies files and folder from local machine it puts them on running instance of the container so that container has access to them. +Command copy copies files and folder from local machine and it puts them on running instance of the container so that container has access to them. **Steps To Follow:** diff --git a/dockerFile-Basics/Chapter 4 - ADD b/dockerFile-Basics/Chapter 4 - ADD index d5fca96..fcc24e4 100644 --- a/dockerFile-Basics/Chapter 4 - ADD +++ b/dockerFile-Basics/Chapter 4 - ADD @@ -1,6 +1,7 @@ # UNDERSTANDING ADD -Add is similar to copy but with more functionality like it extracts the content of compressed files and puts it in docker image and has the ability to download and extract files +Add is similar to copy but with more functionality. For example, it extracts the content of compressed files and puts it in docker image +and has the ability to download and extract files. Navigate to a folder with tar compressed file. @@ -31,4 +32,4 @@ Run in Interactive Mode: docker run --rm add_docker ls/root/Harsh_apps/ to see In place of “Harsh_apps.tar.gz”, a URL can also be given. -It is not recommended, the best practices is to use wget or curl and then move it to the required destination, Go with RUN to use wget and extract things. +It is not recommended, the best practice is to use wget or curl and then move it to the required destination, Go with RUN to use wget and extract things.