Skip to content

Commit 656523e

Browse files
thaJeztahthaJeztah
authored
Merge pull request #5859 from thaJeztah/fix_docs
docs: minor fixes and touch-ups for anchor links
2 parents 77a8a8c + aad2ae5 commit 656523e

File tree

5 files changed

+28
-26
lines changed

5 files changed

+28
-26
lines changed

‎docs/reference/commandline/container_restart.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ container, `SIGTERM` is used as default.
4242
### <a name="timeout"></a> Stop container with timeout (-t, --timeout)
4343

4444
The `--timeout` flag sets the number of seconds to wait for the container
45-
to stop after sending the pre-defined (see [`--signal`]{#signal)) system call signal.
45+
to stop after sending the pre-defined (see [`--signal`](#signal)) system call signal.
4646
If the container does not exit after the timeout elapses, it's forcibly killed
4747
with a `SIGKILL` signal.
4848

‎docs/reference/commandline/network_ls.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ List networks
1313
|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
1414
| [`-f`](#filter), [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `driver=bridge`) |
1515
| [`--format`](#format) | `string` | | Format output using a custom template:<br>'table': Print output in table format with column headers (default)<br>'table TEMPLATE': Print output in table format using the given Go template<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
16-
| `--no-trunc` | `bool` | | Do not truncate the output |
16+
| [`--no-trunc`](#no-trunc) | `bool` | | Do not truncate the output |
1717
| `-q`, `--quiet` | `bool` | | Only display network IDs |
1818

1919

@@ -37,6 +37,8 @@ cf03ee007fb4 host host local
3737
78b03ee04fc4 multi-host overlay swarm
3838
```
3939

40+
### <a name="no-trunc"></a> List networks without truncating the ID column (--no-trun)
41+
4042
Use the `--no-trunc` option to display the full network id:
4143

4244
```console

‎docs/reference/commandline/swarm_join-token.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ Manage join tokens
55

66
### Options
77

8-
| Name | Type | Default | Description |
9-
|:----------------|:-------|:--------|:-------------------|
10-
| `-q`, `--quiet` | `bool` | | Only display token |
11-
| `--rotate` | `bool` | | Rotate join token |
8+
| Name | Type | Default | Description |
9+
|:------------------------------------|:-------|:--------|:-------------------|
10+
| [`-q`](#quiet), [`--quiet`](#quiet) | `bool` | | Only display token |
11+
| [`--rotate`](#rotate) | `bool` | | Rotate join token |
1212

1313

1414
<!---MARKER_GEN_END-->
@@ -77,7 +77,7 @@ $ docker swarm join-token -q worker
7777
SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-b30ljddcqhef9b9v4rs7mel7t
7878
```
7979

80-
### `--rotate`
80+
### <a name="rotate"></a> `--rotate`
8181

8282
Because tokens allow new nodes to join the swarm, you should keep them secret.
8383
Be particularly careful with manager tokens since they allow new manager nodes
@@ -96,7 +96,7 @@ Rotating a join-token means that no new nodes will be able to join the swarm
9696
using the old token. Rotation does not affect existing nodes in the swarm
9797
because the join token is only used for authorizing new nodes joining the swarm.
9898

99-
### `--quiet`
99+
### <a name="quiet"></a> `--quiet`
100100

101101
Only print the token. Do not print a complete command for joining.
102102

‎docs/reference/commandline/swarm_join.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ Join a swarm as a node and/or manager
55

66
### Options
77

8-
| Name | Type | Default | Description |
9-
|:-------------------|:------------|:---------------|:------------------------------------------------------------------------------|
10-
| `--advertise-addr` | `string` | | Advertised address (format: `<ip\|interface>[:port]`) |
11-
| `--availability` | `string` | `active` | Availability of the node (`active`, `pause`, `drain`) |
12-
| `--data-path-addr` | `string` | | Address or interface to use for data path traffic (format: `<ip\|interface>`) |
13-
| `--listen-addr` | `node-addr` | `0.0.0.0:2377` | Listen address (format: `<ip\|interface>[:port]`) |
14-
| `--token` | `string` | | Token for entry into the swarm |
8+
| Name | Type | Default | Description |
9+
|:--------------------------------------|:------------|:---------------|:------------------------------------------------------------------------------|
10+
| [`--advertise-addr`](#advertise-addr) | `string` | | Advertised address (format: `<ip\|interface>[:port]`) |
11+
| [`--availability`](#availability) | `string` | `active` | Availability of the node (`active`, `pause`, `drain`) |
12+
| [`--data-path-addr`](#data-path-addr) | `string` | | Address or interface to use for data path traffic (format: `<ip\|interface>`) |
13+
| [`--listen-addr`](#listen-addr) | `node-addr` | `0.0.0.0:2377` | Listen address (format: `<ip\|interface>[:port]`) |
14+
| [`--token`](#token) | `string` | | Token for entry into the swarm |
1515

1616

1717
<!---MARKER_GEN_END-->
@@ -57,7 +57,7 @@ dkp8vy1dq1kxleu9g4u78tlag worker1 Ready Active Reachable
5757
dvfxp4zseq4s0rih1selh0d20 * manager1 Ready Active Leader
5858
```
5959

60-
### `--listen-addr value`
60+
### <a name="listen-addr"></a> `--listen-addr value`
6161

6262
If the node is a manager, it will listen for inbound swarm manager traffic on this
6363
address. The default is to listen on 0.0.0.0:2377. It is also possible to specify a
@@ -68,7 +68,7 @@ name, the default port 2377 will be used.
6868

6969
This flag is generally not necessary when joining an existing swarm.
7070

71-
### `--advertise-addr value`
71+
### <a name="advertise-addr"></a> `--advertise-addr value`
7272

7373
This flag specifies the address that will be advertised to other members of the
7474
swarm for API access. If unspecified, Docker will check if the system has a
@@ -88,7 +88,7 @@ you're joining new nodes through a load balancer, you should use this flag to
8888
ensure the node advertises its IP address and not the IP address of the load
8989
balancer.
9090

91-
### `--data-path-addr`
91+
### <a name="data-path-addr"></a> `--data-path-addr`
9292

9393
This flag specifies the address that global scope network drivers will publish towards
9494
other nodes in order to reach the containers running on this node.
@@ -97,11 +97,11 @@ management traffic of the cluster.
9797
If unspecified, Docker will use the same IP address or interface that is used for the
9898
advertise address.
9999

100-
### `--token string`
100+
### <a name="token"></a> `--token string`
101101

102102
Secret value required for nodes to join the swarm
103103

104-
### `--availability`
104+
### <a name="availability"></a> `--availability`
105105

106106
This flag specifies the availability of the node at the time the node joins a master.
107107
Possible availability values are `active`, `pause`, or `drain`.

‎docs/reference/commandline/swarm_unlock-key.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ Manage the unlock key
55

66
### Options
77

8-
| Name | Type | Default | Description |
9-
|:----------------|:-------|:--------|:-------------------|
10-
| `-q`, `--quiet` | `bool` | | Only display token |
11-
| `--rotate` | `bool` | | Rotate unlock key |
8+
| Name | Type | Default | Description |
9+
|:------------------------------------|:-------|:--------|:-------------------|
10+
| [`-q`](#quiet), [`--quiet`](#quiet) | `bool` | | Only display token |
11+
| [`--rotate`](#rotate) | `bool` | | Rotate unlock key |
1212

1313

1414
<!---MARKER_GEN_END-->
@@ -67,12 +67,12 @@ $ docker swarm unlock-key -q
6767
SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8
6868
```
6969

70-
### `--rotate`
70+
### <a name="rotate"></a> `--rotate`
7171

7272
This flag rotates the unlock key, replacing it with a new randomly-generated
7373
key. The old unlock key will no longer be accepted.
7474

75-
### `--quiet`
75+
### <a name="quiet"></a> `--quiet`
7676

7777
Only print the unlock key, without instructions.
7878

0 commit comments

Comments
 (0)