Skip to content

Commit

Permalink
Fix wording and linter issues following PR review
Browse files Browse the repository at this point in the history
  • Loading branch information
ptgott committed Apr 15, 2022
1 parent 5650eb7 commit cd1b42b
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
6 changes: 3 additions & 3 deletions docs/pages/setup/admin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ The guides in this section show you the fundamentals of setting up and running a
Teleport cluster. You will learn how to run the `teleport` daemon, manage users
and resources, and troubleshoot any issues that arise.

If you already understand how to set up a Teleport cluster, you should consult
the [Operations](./operations.mdx) section so you can start conducting periodic
If you already understand how to set up a Teleport cluster, consult the
[Operations](./operations.mdx) section so you can start conducting periodic
cluster maintenance tasks.

## Run Teleport
Expand All @@ -30,7 +30,7 @@ cluster maintenance tasks.
Set up single sign-on with GitHub.
</Tile>
<Tile href="./admin/adding-nodes.mdx" title="Adding Nodes" icon="wrench">
How to add Nodes to your Teleport cluster.
Add Nodes to your Teleport cluster.
</Tile>
<Tile href="./admin/trustedclusters.mdx" title="Trusted Clusters" icon="wrench">
Connect multiple Teleport clusters using Trusted Clusters.
Expand Down
6 changes: 3 additions & 3 deletions docs/pages/setup/admin/adding-nodes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -114,11 +114,11 @@ auth_service:
### Start your Node with the invite token and CA pin
The CA pin at the needs to be passed to new Nodes when they're
starting for the first time, i.e. when they join a cluster.
A CA pin needs to be passed to new Nodes when they're starting for the first
time, i.e. when they join a cluster.
If a CA pin is not provided, the Teleport Node will join a cluster but it will
print a `WARN` message (warning).
print a warning message.
<Notice type="warning">
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/setup/deployments/aws-terraform.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -714,7 +714,7 @@ To add new nodes/EC2 servers that you can "SSH into" you'll need to:
- [Install the Teleport binary on the Server](../../installation.mdx)
- [Run Teleport - we recommend using systemd](../admin/daemon.mdx#systemd-unit-file)
- [Set the correct settings in /etc/teleport.yaml](../reference/config.mdx)
- [Add nodes to the Teleport cluster](../admin/adding-nodes.mdx#adding-nodes-to-the-cluster)
- [Add Nodes to the Teleport cluster](../admin/adding-nodes.mdx)

### Getting the CA pin hash

Expand All @@ -736,7 +736,7 @@ $ aws ssm get-parameter --region ${TF_VAR_region} --name "/teleport/${TF_VAR_clu
# 992a9725-0a64-428d-8e5e-308e6877743d
```

You can also generate a node join token using `tctl tokens add --type=node` [as detailed here in our admin guide](../admin/adding-nodes.mdx#adding-nodes-to-the-cluster).
You can also generate a Node join token using `tctl tokens add --type=node` [as detailed here in our admin guide](../admin/adding-nodes.mdx).

### Joining nodes via the Teleport auth server

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/setup/operations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ the [Cluster Administration Guides](./admin.mdx) section.
Backing up and restoring the cluster.
</Tile>
<Tile href="./operations/ca-rotation.mdx" title="CA Rotation" icon="wrench">
Rotating certificates and certificate authorities.
Rotating Teleport certificate authorities.
</Tile>
<Tile href="./operations/tls-routing.mdx" title="TLS Routing Migration" icon="wrench">
Migrating your Teleport cluster to single-port TLS routing mode.
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/setup/operations/ca-rotation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: How to rotate Teleport's certificate authority

This section will show you how to implement certificate rotation in practice.

If you are using [CA Pinning](../admin/adding-nodes.mdx#untrusted-auth-servers)
If you are using [CA Pinning](../admin/adding-nodes.mdx#obtain-a-ca-pin)
when adding new nodes, the CA pin will change after the rotation. Make sure you
use the *new* CA pin when adding nodes after rotation.

Expand Down

0 comments on commit cd1b42b

Please sign in to comment.