Skip to content

Commit b8aa7da

Browse files
abhisheksr01abhisheksr01
committed
docs(README): #353 remove author,contributor,acknowledgment redundant headings
1 parent fcf88f5 commit b8aa7da

File tree

3 files changed

+11
-53
lines changed

3 files changed

+11
-53
lines changed

‎.github/workflows/create-repo-visualization.yml‎

Lines changed: 0 additions & 14 deletions
This file was deleted.

‎README.md‎

Lines changed: 11 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,7 @@
4141
- [7.2 Google Cloud Run](#72-google-cloud-run)
4242
- [What to expect Next!](#what-to-expect-next)
4343
- [Versioning](#versioning)
44-
- [Author](#author)
45-
- [Contributors](#contributors)
4644
- [License](#license)
47-
- [Acknowledgments](#acknowledgments)
4845

4946
---
5047

@@ -78,16 +75,6 @@ Execute below gradlew command to download all the dependencies specified in the
7875
./gradlew clean build
7976
```
8077

81-
As the codebase grows it becomes difficult to visualize the content in it.
82-
83-
Visualization gives enough of a “fingerprint” that viewers can glance at it and see the structure of the codebase.
84-
85-
Thanks to [repo-visualization](https://octo.github.com/projects/repo-visualization) for giving us enough of a “fingerprint” to glance and see the structure of the codebase as below:
86-
87-
![Visualization of the codebase](./diagram.svg)
88-
89-
<a propertyName = "MSStructure"></a>
90-
9178
### Microservice Structure
9279

9380
We are following Classic Microservice "Separation of Concerns" pattern having Controller <--> Service <--> Connector layers.
@@ -626,17 +613,17 @@ Before we continue further make sure you have docker installed, if not [click he
626613
627614
Docker uses a text file with set of instructions in it to build a docker image. Below given is a list of some of the most common Docker keywords used:
628615
629-
| KEYWORD | Usage Description |
630-
|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------|
631-
| FROM | Defines the base image to use to start the build process. A image defined here will be pulled from Docker Hub or other container repository. It needs to be the first command declared inside a Dockerfile. |
632-
| WORKDIR | Set where the command defined with CMD is to be executed. |
633-
| ENV | Sets an Environment variable within the container & can be accessed by scripts and applications alike. |
634-
| CMD | Execute the given command when a container is instantiated using the image being built. |
635-
| RUN | Execute any additional command when docker image is built. |
636-
| EXPOSE | Used to associate a specified port to enable networking between the running process inside the container and the outside world (i.e. the host). |
637-
| COPY | Takes in a src and destination arguments & copy a local file or directory from your host (the machine building the Docker image) into the Docker image itself. |
638-
| ADD | Apart from what COPY does, it also supports 2 other sources. First, you can use a URL instead of a local file / directory. Secondly, you can extract a tar file from the source directly into the destination. |
639-
| ENTRYPOINT | Sets the concrete default application that is used every time a container is created using the image. For example, here we are using Spring Boot application inside the image. To only run that application use ENTRYPOINT and whenever a container is created our application will be the target. If we couple ENTRYPOINT with CMD, we can remove “application” from CMD and just leave “arguments” which will be passed to the ENTRYPOINT. |
616+
| KEYWORD | Usage Description |
617+
|:-----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
618+
| FROM | Defines the base image to use to start the build process. A image defined here will be pulled from Docker Hub or other container repository. It needs to be the first command declared inside a Dockerfile. |
619+
| WORKDIR | Set where the command defined with CMD is to be executed. |
620+
| ENV | Sets an Environment variable within the container & can be accessed by scripts and applications alike. |
621+
| CMD | Execute the given command when a container is instantiated using the image being built. |
622+
| RUN | Execute any additional command when docker image is built. |
623+
| EXPOSE | Used to associate a specified port to enable networking between the running process inside the container and the outside world (i.e. the host). |
624+
| COPY | Takes in a src and destination arguments & copy a local file or directory from your host (the machine building the Docker image) into the Docker image itself. |
625+
| ADD | Apart from what COPY does, it also supports 2 other sources. First, you can use a URL instead of a local file / directory. Secondly, you can extract a tar file from the source directly into the destination. |
626+
| ENTRYPOINT | Sets the concrete default application that is used every time a container is created using the image. For example, here we are using Spring Boot application inside the image. To only run that application use ENTRYPOINT and whenever a container is created our application will be the target. If we couple ENTRYPOINT with CMD, we can remove “application” from CMD and just leave “arguments” which will be passed to the ENTRYPOINT. |
640627
641628
Now let us have a quick look at our [ci.Dockerfile](./ci.Dockerfile) given below:
642629
@@ -1088,22 +1075,8 @@ We use [SemVer](http://semver.org/) for versioning. For the versions
10881075
available, see the
10891076
[tags on this repository](https://github.com/your/project/tags).
10901077
1091-
### Author
1092-
1093-
- **Abhishek Singh Rajput** - _Initial work_ -
1094-
[abhisheksr01](https://github.com/abhisheksr01)
1095-
1096-
### Contributors
1097-
1098-
As mentioned in the [Introduction](#introduction) through this project we would like to bring the Best Practices and Integration under one umbrella.
1099-
1100-
So you are most welcome to improve or add new features you could think of.
1101-
11021078
### License
11031079
11041080
This project is licensed under the MIT License - see the
11051081
[LICENSE.md](LICENSE.md) file for details
11061082
1107-
### Acknowledgments
1108-
1109-
- [Eugen Paraschiv](https://www.baeldung.com/) : For wonderful tutorials

‎diagram.svg‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)