Skip to content

Commit

Permalink
correct suprious em dashes in documentation
Browse files Browse the repository at this point in the history
-- is converted to an em dash by the MDX markdown parser.

This comes up in command line arguments, so just use inline code
blocks for them (as we already do in most places).

Also corrects two typos.

Fixes #3070.
  • Loading branch information
travisdowns committed Nov 30, 2021
1 parent 9fc6bc2 commit c8143c0
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/www/rpk-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ Flags:

OS support: ![Linux][linux]

Initialize the configuration to bootstrap a cluster. --id is mandatory. `bootstrap` will expect the machine it's running on to have only one non-loopback IP address associated to it, and use it in the configuration as the node's address. If it has multiple IPs, --self must be specified. In that case, the given IP will be used without checking whether it's among the machine's addresses or not. The elements in --ips must be separated by a comma, no spaces. If omitted, the node will be configured as a root node, that otherones can join later.
Initialize the configuration to bootstrap a cluster. `--id` is mandatory. `bootstrap` will expect the machine it's running on to have only one non-loopback IP address associated to it, and use it in the configuration as the node's address. If it has multiple IPs, `--self` must be specified. In that case, the given IP will be used without checking whether it's among the machine's addresses or not. The elements in `--ips` must be separated by a comma, no spaces. If omitted, the node will be configured as a root node, that other ones can join later.

```cmd
Usage:
Expand Down Expand Up @@ -531,7 +531,7 @@ If `--seed-addr` is passed, it will be used to discover the rest of the cluster
hosts via redpanda's Kafka API. If `--node-addrs` is passed, they will be used
directly. Otherwise, `rpk generate prometheus-conf` will read the redpanda
config file and use the node IP configured there. `--config` may be passed to
especify an arbitrary config file.
specify an arbitrary config file.

```cmd
Usage:
Expand Down

0 comments on commit c8143c0

Please sign in to comment.