[v2] docs: markdown and link fixes

Signed-off-by: Sebastiaan van Stijn <[email protected]>

docs/reference/compose.md

@@ -15,9 +15,10 @@ to their predecessors.
 
 For example, consider this command line:
 
-```
+```console
 $ docker compose -f docker-compose.yml -f docker-compose.admin.yml run backup_db
 ```
+
 The `docker-compose.yml` file might specify a `webapp` service.
 
 ```yaml
@@ -56,8 +57,9 @@ from the command line or by setting up a `COMPOSE_FILE` environment variable in
 For an example of using the `-f` option at the command line, suppose you are running the Compose Rails sample, and 
 have a `compose.yaml` file in a directory called `sandbox/rails`. You can use a command like `docker compose pull` to 
 get the postgres image for the db service from anywhere by using the `-f` flag as follows: 
-```
-docker compose -f ~/sandbox/rails/compose.yaml pull db
+
+```console
+$ docker compose -f ~/sandbox/rails/compose.yaml pull db
 ```
 
 ### Use `-p` to specify a project name
@@ -69,7 +71,7 @@ Project name can also be set by `COMPOSE_PROJECT_NAME` environment variable.
 Most compose subcommand can be ran without a compose file, just passing 
 project name to retrieve the relevant resources.
 
-```
+```console
 $ docker compose -p my_project ps -a
 NAME                 SERVICE    STATUS     PORTS
 my_project_demo_1    demo       running             

docs/reference/compose_build.md

@@ -9,4 +9,4 @@ the image is tagged with that name, substituting any variables beforehand. See
 [variable interpolation](https://github.com/compose-spec/compose-spec/blob/master/spec.md#interpolation).
 
 If you change a service's `Dockerfile` or the contents of its build directory, 
-run `docker compose build` to rebuild it.
+run `docker compose build` to rebuild it.

docs/reference/compose_events.md

@@ -19,4 +19,4 @@ With the `--json` flag, a json object is printed one per line with the format:
 }
 ```
 
-The events that can be received using this can be seen [here](/engine/reference/commandline/events/#object-types).
+The events that can be received using this can be seen [here](https://docs.docker.com/engine/reference/commandline/events/#object-types).

docs/reference/compose_kill.md

@@ -3,6 +3,6 @@
 
 Forces running containers to stop by sending a `SIGKILL` signal. Optionally the signal can be passed, for example:
 
-```
-docker-compose kill -s SIGINT
+```console
+$ docker-compose kill -s SIGINT
 ```

docs/reference/compose_ps.md

@@ -3,9 +3,9 @@
 
 Lists containers for a Compose project, with current status and exposed ports.
 
-```
+```console
 $ docker compose ps
 NAME                SERVICE             STATUS              PORTS
 example_foo_1       foo                 running (healthy)   0.0.0.0:8000->80/tcp
 example_bar_1       bar                 exited (1)          
-```
+```

docs/reference/compose_pull.md

@@ -7,7 +7,7 @@ those images.
 
 ## Examples 
 
-suppose you have this `compose.yaml` file from the Quickstart: [Compose and Rails sample](compose/rails/).
+suppose you have this `compose.yaml`:
 
 ```yaml
 services:
@@ -17,18 +17,18 @@ services:
     build: .
     command: bundle exec rails s -p 3000 -b '0.0.0.0'
     volumes:
-    - .:/myapp
+      - .:/myapp
     ports:
-    - "3000:3000"
+      - "3000:3000"
     depends_on:
-    - db
+      - db
 ```
 
-If you run `docker compose pull ServiceName` in the same directory as the `ccompose.yaml` file that defines the service, 
+If you run `docker compose pull ServiceName` in the same directory as the `compose.yaml` file that defines the service, 
 Docker pulls the associated image. For example, to call the postgres image configured as the db service in our example, 
 you would run `docker compose pull db`.
 
-```
+```console
 $ docker compose pull db
 [+] Running 1/15
  ⠸ db Pulling                                                             12.4s

docs/reference/compose_push.md

@@ -11,11 +11,11 @@ Examples
 
 ```yaml
 services:
-    service1:
-        build: .
-        image: localhost:5000/yourimage  ## goes to local registry
-    
-    service2:
-        build: .
-        image: your-dockerid/yourimage  ## goes to your repository on Docker Hub
-```
+  service1:
+    build: .
+    image: localhost:5000/yourimage  ## goes to local registry
+
+  service2:
+    build: .
+    image: your-dockerid/yourimage  ## goes to your repository on Docker Hub
+```

docs/reference/compose_restart.md

@@ -7,4 +7,4 @@ after restarting.
 
 If you are looking to configure a service's restart policy, please refer to
 [restart](https://github.com/compose-spec/compose-spec/blob/master/spec.md#restart)
-or [restart_policy](https://github.com/compose-spec/compose-spec/blob/master/deploy.md#restart_policy).
+or [restart_policy](https://github.com/compose-spec/compose-spec/blob/master/deploy.md#restart_policy).

docs/reference/compose_rm.md

@@ -10,9 +10,9 @@ Any data which is not in a volume is lost.
 
 Running the command with no options also removes one-off containers created by `docker compose run`:
 
-```
+```console
 $ docker compose rm
 Going to remove djangoquickstart_web_run_1
 Are you sure? [yN] y
 Removing djangoquickstart_web_run_1 ... done
-```
+```

docs/reference/compose_run.md

@@ -3,8 +3,11 @@
 
 Runs a one-time command against a service. 
 
-the following command starts the `web` service and runs `bash` as its command.
-`docker compose run web bash`
+the following command starts the `web` service and runs `bash` as its command:
+
+```console
+$ docker compose run web bash
+```
 
 Commands you use with run start in new containers with configuration defined by that of the service,
 including volumes, links, and other details. However, there are two important differences:
@@ -17,38 +20,37 @@ The second difference is that the `docker compose run` command does not create a
 service configuration. This prevents port collisions with already-open ports. If you do want the service’s ports 
 to be created and mapped to the host, specify the `--service-ports`
 
-```
-docker compose run --service-ports web python manage.py shell
+```console
+$ docker compose run --service-ports web python manage.py shell
 ```
 
 Alternatively, manual port mapping can be specified with the `--publish` or `-p` options, just as when using docker run:
 
-```
-docker compose run --publish 8080:80 -p 2022:22 -p 127.0.0.1:2021:21 web python manage.py shell
+```console
+$ docker compose run --publish 8080:80 -p 2022:22 -p 127.0.0.1:2021:21 web python manage.py shell
 ```
 
-
 If you start a service configured with links, the run command first checks to see if the linked service is running 
 and starts the service if it is stopped. Once all the linked services are running, the run executes the command you 
 passed it. For example, you could run:
 
-```
-docker compose run db psql -h db -U docker
+```console
+$ docker compose run db psql -h db -U docker
 ```
 
 This opens an interactive PostgreSQL shell for the linked `db` container.
 
 If you do not want the run command to start linked containers, use the `--no-deps` flag:
 
-```
-docker compose run --no-deps web python manage.py shell
+```console
+$ docker compose run --no-deps web python manage.py shell
 ```
 
 If you want to remove the container after running while overriding the container’s restart policy, use the `--rm` flag:
 
-```
-docker compose run --rm web python manage.py db upgrade
+```console
+$ docker compose run --rm web python manage.py db upgrade
 ```
 
 This runs a database upgrade script, and removes the container when finished running, even if a restart policy is 
-specified in the service configuration.
+specified in the service configuration.

docs/reference/compose_start.md

@@ -1,4 +1,4 @@
 
 ## Description
 
-Starts existing containers for a service.
+Starts existing containers for a service.

docs/reference/compose_stop.md

@@ -1,4 +1,4 @@
 
 ## Description
 
-Stops running containers without removing them. They can be started again with `docker compose start`.
+Stops running containers without removing them. They can be started again with `docker compose start`.

docs/reference/compose_top.md

@@ -5,9 +5,9 @@ Displays the running processes.
 
 ## Examples
 
-```
+```console
 $ docker compose top
 example_foo_1
 UID    PID      PPID     C    STIME   TTY   TIME       CMD
 root   142353   142331   2    15:33   ?     00:00:00   ping localhost -c 5 
-```
+```

docs/reference/compose_unpause.md

@@ -1,4 +1,4 @@
 
 ## Description
 
-Unpauses paused containers of a service.
+Unpauses paused containers of a service.

docs/reference/docker_compose_events.yaml

@@ -19,7 +19,7 @@ long: |-
     }
     ```
 
-    The events that can be received using this can be seen [here](/engine/reference/commandline/events/#object-types).
+    The events that can be received using this can be seen [here](https://docs.docker.com/engine/reference/commandline/events/#object-types).
 usage: docker compose events [options] [--] [SERVICE...]
 pname: docker compose
 plink: docker_compose.yaml

docs/reference/docker_compose_kill.yaml

@@ -3,8 +3,8 @@ short: Force stop service containers.
 long: |-
     Forces running containers to stop by sending a `SIGKILL` signal. Optionally the signal can be passed, for example:
 
-    ```
-    docker-compose kill -s SIGINT
+    ```console
+    $ docker-compose kill -s SIGINT
     ```
 usage: docker compose kill [options] [SERVICE...]
 pname: docker compose

docs/reference/docker_compose_ps.yaml

@@ -1,6 +1,6 @@
 command: docker compose ps
 short: List containers
-long: "Lists containers for a Compose project, with current status and exposed ports.\n\n```\n$ docker compose ps\nNAME                SERVICE             STATUS              PORTS\nexample_foo_1       foo                 running (healthy)   0.0.0.0:8000->80/tcp\nexample_bar_1       bar                 exited (1)          \n```"
+long: "Lists containers for a Compose project, with current status and exposed ports.\n\n```console\n$ docker compose ps\nNAME                SERVICE             STATUS              PORTS\nexample_foo_1       foo                 running (healthy)   0.0.0.0:8000->80/tcp\nexample_bar_1       bar                 exited (1)          \n```"
 usage: docker compose ps [SERVICE...]
 pname: docker compose
 plink: docker_compose.yaml

docs/reference/docker_compose_pull.yaml

@@ -51,7 +51,7 @@ options:
       experimentalcli: false
       kubernetes: false
       swarm: false
-examples: "suppose you have this `compose.yaml` file from the Quickstart: [Compose and Rails sample](compose/rails/).\n\n```yaml\nservices:\n  db:\n    image: postgres\n  web:\n    build: .\n    command: bundle exec rails s -p 3000 -b '0.0.0.0'\n    volumes:\n    - .:/myapp\n    ports:\n    - \"3000:3000\"\n    depends_on:\n    - db\n```\n\nIf you run `docker compose pull ServiceName` in the same directory as the `ccompose.yaml` file that defines the service, \nDocker pulls the associated image. For example, to call the postgres image configured as the db service in our example, \nyou would run `docker compose pull db`.\n\n```\n$ docker compose pull db\n[+] Running 1/15\n ⠸ db Pulling                                                             12.4s\n   ⠿ 45b42c59be33 Already exists                                           0.0s\n   ⠹ 40adec129f1a Downloading  3.374MB/4.178MB                             9.3s\n   ⠹ b4c431d00c78 Download complete                                        9.3s\n   ⠹ 2696974e2815 Download complete                                        9.3s\n   ⠹ 564b77596399 Downloading  5.622MB/7.965MB                             9.3s\n   ⠹ 5044045cf6f2 Downloading  216.7kB/391.1kB                             9.3s\n   ⠹ d736e67e6ac3 Waiting                                                  9.3s\n   ⠹ 390c1c9a5ae4 Waiting                                                  9.3s\n   ⠹ c0e62f172284 Waiting                                                  9.3s\n   ⠹ ebcdc659c5bf Waiting                                                  9.3s\n   ⠹ 29be22cb3acc Waiting                                                  9.3s\n   ⠹ f63c47038e66 Waiting                                                  9.3s\n   ⠹ 77a0c198cde5 Waiting                                                  9.3s\n   ⠹ c8752d5b785c Waiting                                                  9.3s\n``̀"
+examples: "suppose you have this `compose.yaml`:\n\n```yaml\nservices:\n  db:\n    image: postgres\n  web:\n    build: .\n    command: bundle exec rails s -p 3000 -b '0.0.0.0'\n    volumes:\n      - .:/myapp\n    ports:\n      - \"3000:3000\"\n    depends_on:\n      - db\n```\n\nIf you run `docker compose pull ServiceName` in the same directory as the `compose.yaml` file that defines the service, \nDocker pulls the associated image. For example, to call the postgres image configured as the db service in our example, \nyou would run `docker compose pull db`.\n\n```console\n$ docker compose pull db\n[+] Running 1/15\n ⠸ db Pulling                                                             12.4s\n   ⠿ 45b42c59be33 Already exists                                           0.0s\n   ⠹ 40adec129f1a Downloading  3.374MB/4.178MB                             9.3s\n   ⠹ b4c431d00c78 Download complete                                        9.3s\n   ⠹ 2696974e2815 Download complete                                        9.3s\n   ⠹ 564b77596399 Downloading  5.622MB/7.965MB                             9.3s\n   ⠹ 5044045cf6f2 Downloading  216.7kB/391.1kB                             9.3s\n   ⠹ d736e67e6ac3 Waiting                                                  9.3s\n   ⠹ 390c1c9a5ae4 Waiting                                                  9.3s\n   ⠹ c0e62f172284 Waiting                                                  9.3s\n   ⠹ ebcdc659c5bf Waiting                                                  9.3s\n   ⠹ 29be22cb3acc Waiting                                                  9.3s\n   ⠹ f63c47038e66 Waiting                                                  9.3s\n   ⠹ 77a0c198cde5 Waiting                                                  9.3s\n   ⠹ c8752d5b785c Waiting                                                  9.3s\n``̀"
 deprecated: false
 experimental: false
 experimentalcli: false

docs/reference/docker_compose_push.yaml

@@ -1,6 +1,24 @@
 command: docker compose push
 short: Push service images
-long: "Pushes images for services to their respective registry/repository.\n\nThe following assumptions are made:\n- You are pushing an image you have built locally\n- You have access to the build key\n\nExamples\n\n```yaml\nservices:\n    service1:\n        build: .\n        image: localhost:5000/yourimage  ## goes to local registry\n    \n    service2:\n        build: .\n        image: your-dockerid/yourimage  ## goes to your repository on Docker Hub\n```"
+long: |-
+    Pushes images for services to their respective registry/repository.
+
+    The following assumptions are made:
+    - You are pushing an image you have built locally
+    - You have access to the build key
+
+    Examples
+
+    ```yaml
+    services:
+      service1:
+        build: .
+        image: localhost:5000/yourimage  ## goes to local registry
+
+      service2:
+        build: .
+        image: your-dockerid/yourimage  ## goes to your repository on Docker Hub
+    ```
 usage: docker compose push [SERVICE...]
 pname: docker compose
 plink: docker_compose.yaml

docs/reference/docker_compose_rm.yaml

@@ -10,7 +10,7 @@ long: |-
 
     Running the command with no options also removes one-off containers created by `docker compose run`:
 
-    ```
+    ```console
     $ docker compose rm
     Going to remove djangoquickstart_web_run_1
     Are you sure? [yN] y

docs/reference/docker_compose_top.yaml

@@ -4,7 +4,7 @@ long: Displays the running processes.
 usage: docker compose top [SERVICES...]
 pname: docker compose
 plink: docker_compose.yaml
-examples: "```\n$ docker compose top\nexample_foo_1\nUID    PID      PPID     C    STIME   TTY   TIME       CMD\nroot   142353   142331   2    15:33   ?     00:00:00   ping localhost -c 5 \n```"
+examples: "```console\n$ docker compose top\nexample_foo_1\nUID    PID      PPID     C    STIME   TTY   TIME       CMD\nroot   142353   142331   2    15:33   ?     00:00:00   ping localhost -c 5 \n```"
 deprecated: false
 experimental: false
 experimentalcli: false