diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aee9e3419..ef30cee20 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -153,7 +153,7 @@ Here are some dependents with specific version: * shellCheck : latest * docker: latest -When you develop the Dragonfly project at the local environment, you should use subcommands of Makefile to help yourself to check and build the latest version of Dragonfly. For the convenience of developers, we use the docker to build Dragonfly. It can reduce problems of the developing environment. +When you develop the Dragonfly project at the local environment, you should use subcommands of Makefile to help yourself to check and build the latest version of Dragonfly. For the convenience of developers, we use the docker to build Dragonfly. It can reduce problems of the developing environment. ### Golang Dependency Management diff --git a/cmd/supernode/app/version.go b/cmd/supernode/app/version.go index 57bbfef51..a315176f0 100644 --- a/cmd/supernode/app/version.go +++ b/cmd/supernode/app/version.go @@ -25,7 +25,7 @@ import ( ) // versionDescription is used to describe version command in detail and auto generate command doc. -var versionDescription = "Display the version and build information of Dragonfly supernode, " + +var versionDescription = "Display the version and build information of Dragonfly supernode, " + "including GoVersion, OS, Arch, Version, BuildDate and GitCommit." var versionCmd = &cobra.Command{ diff --git a/docs/quick_start/README.md b/docs/quick_start/README.md index 45cbc4de6..3125e3bcf 100644 --- a/docs/quick_start/README.md +++ b/docs/quick_start/README.md @@ -14,7 +14,7 @@ All steps in this document are done on the same machine using the docker contain docker run -d --name supernode --restart=always -p 8001:8001 -p 8002:8002 -v /home/admin/supernode:/home/admin/supernode dragonflyoss/supernode:0.4.3 ``` -## Step 2:Deploy Dragonfly Client (dfclient) +## Step 2: Deploy Dragonfly Client (dfclient) ```bash SUPERNODE_IP=`docker inspect supernode -f '{{.NetworkSettings.Networks.bridge.IPAddress}}'` @@ -40,13 +40,13 @@ We need to modify the Docker Daemon configuration to use the Dragonfly as a pull **Tip:** For more information on `/etc/docker/daemon.json`, see [Docker documentation](https://docs.docker.com/registry/recipes/mirror/#configure-the-cache). -2. Restart Docker Daemon。 +2. Restart Docker Daemon. ```bash systemctl restart docker ``` -## Step 4:Pull images with Dragonfly +## Step 4: Pull images with Dragonfly Through the above steps, we can start to validate if Dragonfly works as expected. @@ -56,7 +56,7 @@ And you can pull the image as usual, for example: docker pull nginx:latest ``` -## Step 5:Validate Dragonfly +## Step 5: Validate Dragonfly You can execute the following command to check if the nginx image is distributed via Dragonfly. diff --git a/docs/user_guide/multi_machines_deployment.md b/docs/user_guide/multi_machines_deployment.md index a4bd22afb..a5c56ff82 100644 --- a/docs/user_guide/multi_machines_deployment.md +++ b/docs/user_guide/multi_machines_deployment.md @@ -28,7 +28,7 @@ Deploy the Dragonfly server (Supernode) on the machine `dfsupernode`. docker run -d --name supernode --restart=always -p 8001:8001 -p 8002:8002 -v /home/admin/supernode:/home/admin/supernode dragonflyoss/supernode:0.4.3 --download-port=8001 ``` -## Step 2:Deploy Dragonfly Client (dfclient) +## Step 2: Deploy Dragonfly Client (dfclient) The following operations should be performed both on the client machine `dfclient0`, `dfclient1`. @@ -70,13 +70,13 @@ We need to modify the Docker Daemon configuration to use the Dragonfly as a pull **Tip:** For more information on `/etc/docker/daemon.json`, see [Docker documentation](https://docs.docker.com/registry/recipes/mirror/#configure-the-cache). -2. Restart Docker Daemon。 +2. Restart Docker Daemon. ```bash systemctl restart docker ``` -## Step 4:Pull images with Dragonfly +## Step 4: Pull images with Dragonfly Through the above steps, we can start to validate if Dragonfly works as expected. @@ -86,7 +86,7 @@ And you can pull the image as usual on either `dfclient0` or `dfclient1`, for ex docker pull nginx:latest ``` -## Step 5:Validate Dragonfly +## Step 5: Validate Dragonfly You can execute the following command to check if the nginx image is distributed via Dragonfly. diff --git a/test/README.md b/test/README.md index b68feac03..ea1d4d2a4 100644 --- a/test/README.md +++ b/test/README.md @@ -85,7 +85,7 @@ GOROOT=/usr/local/go GOPATH=/go ``` -Then copy or clone Dragonfly source code to the GOPATH: +Then copy or clone Dragonfly source code to the GOPATH: ``` shell # pwd