Skip to content

Commit ba5213b

Browse files
authored
Merge pull request #2056 from grjan7/main
docs: added punctuation
2 parents b016843 + 47b3109 commit ba5213b

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -111,15 +111,15 @@ $ docker run -it --rm --name my-running-script -v "$PWD":/usr/src/app -w /usr/sr
111111

112112
### Verbosity
113113

114-
Prior to 8.7.0 and 6.11.4 the docker images overrode the default npm log
115-
level from `warn` to `info`. However due to improvements to npm and new Docker
114+
Prior to 8.7.0 and 6.11.4, the docker images overrode the default npm log
115+
level from `warn` to `info`. However, due to improvements to npm and new Docker
116116
patterns (e.g. multi-stage builds) the working group reached a [consensus](https://github.com/nodejs/docker-node/issues/528)
117117
to revert the log level to npm defaults. If you need more verbose output, please
118118
use one of the following methods to change the verbosity level.
119119

120120
#### Dockerfile
121121

122-
If you create your own `Dockerfile` which inherits from the `node` image you can
122+
If you create your own `Dockerfile` which inherits from the `node` image, you can
123123
simply use `ENV` to override `NPM_CONFIG_LOGLEVEL`.
124124

125125
```dockerfile
@@ -130,7 +130,7 @@ ENV NPM_CONFIG_LOGLEVEL info
130130

131131
#### Docker Run
132132

133-
If you run the node image using `docker run` you can use the `-e` flag to
133+
If you run the node image using `docker run`, you can use the `-e` flag to
134134
override `NPM_CONFIG_LOGLEVEL`.
135135

136136
```console
@@ -139,7 +139,7 @@ $ docker run -e NPM_CONFIG_LOGLEVEL=info node ...
139139

140140
#### NPM run
141141

142-
If you are running npm commands you can use `--loglevel` to control the
142+
If you are running npm commands, you can use `--loglevel` to control the
143143
verbosity of the output.
144144

145145
```console

docs/BestPractices.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ ENV PATH=$PATH:/home/node/.npm-global/bin # optionally if you want to run npm gl
4444

4545
If you need to upgrade/downgrade `yarn` for a local install, you can do so by issuing the following commands in your `Dockerfile`:
4646

47-
> Note that if you create some other directory which is not a descendant one from where you ran the command, you will end up using the global (dated) version. If you wish to upgrade `yarn` globally follow the instructions in the next section.
47+
> Note that if you create some other directory which is not a descendant one from where you ran the command, you will end up using the global (dated) version. If you wish to upgrade `yarn` globally, follow the instructions in the next section.
4848
4949
> When following the local install instructions, due to duplicated yarn the image will end up being bigger.
5050
@@ -115,7 +115,7 @@ USER node
115115

116116
Note that the `node` user is neither a build-time nor a run-time dependency and it can be removed or altered, as long as the functionality of the application you want to add to the container does not depend on it.
117117

118-
If you do not want nor need the user created in this image you can remove it with the following:
118+
If you do not want nor need the user created in this image, you can remove it with the following:
119119

120120
```Dockerfile
121121
# For debian based images use:
@@ -125,13 +125,13 @@ RUN userdel -r node
125125
RUN deluser --remove-home node
126126
```
127127

128-
If you need to change the uid/gid of the user you can use:
128+
If you need to change the uid/gid of the user, you can use:
129129

130130
```Dockerfile
131131
RUN groupmod -g 999 node && usermod -u 999 -g 999 node
132132
```
133133

134-
If you need another name for the user (ex. `myapp`) execute:
134+
If you need another name for the user (ex. `myapp`), execute:
135135

136136
```Dockerfile
137137
RUN usermod -d /home/myapp -l myapp node
@@ -147,15 +147,15 @@ RUN deluser --remove-home node \
147147

148148
## Memory
149149

150-
By default, any Docker Container may consume as much of the hardware such as CPU and RAM. If you are running multiple containers on the same host you should limit how much memory they can consume.
150+
By default, any Docker Container may consume as much of the hardware such as CPU and RAM. If you are running multiple containers on the same host, you should limit how much memory they can consume.
151151

152152
```
153153
-m "300M" --memory-swap "1G"
154154
```
155155

156156
## CMD
157157

158-
When creating an image, you can bypass the `package.json`'s `start` command and bake it directly into the image itself. First off this reduces the number of processes running inside of your container. Secondly it causes exit signals such as `SIGTERM` and `SIGINT` to be received by the Node.js process instead of npm swallowing them.
158+
When creating an image, you can bypass the `package.json`'s `start` command and bake it directly into the image itself. First off, this reduces the number of processes running inside of your container. Secondly, it causes exit signals such as `SIGTERM` and `SIGINT` to be received by the Node.js process instead of npm swallowing them.
159159

160160
```Dockerfile
161161
CMD ["node","index.js"]
@@ -192,7 +192,7 @@ RUN apk add --no-cache --virtual .gyp python3 make g++ \
192192
&& apk del .gyp
193193
```
194194

195-
And Here's a multistage build example
195+
And, here's a multistage build example:
196196

197197
```Dockerfile
198198
FROM node:alpine as builder

0 commit comments

Comments
 (0)