Skip to content

Commit

Permalink
Fix markdown-lint issues (#48368)
Browse files Browse the repository at this point in the history
Running markdown-lint in the Docusaurus site flags some issues that the
gravitational/docs markdown-lint configuration doesn't catch. This
change resolves these issues, fixing indentation and list item spacing.
  • Loading branch information
ptgott authored Nov 4, 2024
1 parent 2ec0de6 commit 178c922
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -198,12 +198,12 @@ chart.

1. Install the `teleport-cluster` Helm chart using the values file you wrote:

```code
$ helm install teleport-cluster teleport/teleport-cluster \
--create-namespace \
--version (=teleport.version=) \
--values teleport-cluster-values.yaml
```
```code
$ helm install teleport-cluster teleport/teleport-cluster \
--create-namespace \
--version (=teleport.version=) \
--values teleport-cluster-values.yaml
```

1. After installing the `teleport-cluster` chart, wait a minute or so and ensure
that both the Auth Service and Proxy Service pods are running:
Expand Down
1 change: 1 addition & 0 deletions docs/pages/admin-guides/deploy-a-cluster/hsm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ to use.
DEBU[0000] preflight complete cert= config= key= pid=73502 seccomp=false serial= syslog=false timeout=0s version=3.0.3
DEBU[0000] takeoff TLS=false listen="localhost:12345" pid=73502
```

1. Use `yubihsm-shell` to create a new authentication key to be used by
Teleport with the necessary capabilities.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ provider in these environments.
(!docs/pages/includes/commercial-prereqs-tabs.mdx!)

- (!docs/pages/includes/tctl.mdx!)

- [Terraform >= (=terraform.version=)+](https://learn.hashicorp.com/tutorials/terraform/install-cli)

```code
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ videoBanner: 6lgVObxoLkc
</Admonition>

- (!docs/pages/includes/tctl.mdx!)

- A certificate authority for MongoDB Replica Set, and the public certificate
for that CA, in PEM format: `<Var name="/path/to/your/ca.crt" />`. You can
also configure Teleport to trust this CA for standalone MongoDB instances.
Expand Down
8 changes: 4 additions & 4 deletions docs/pages/upgrading/automatic-agent-updates.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -316,10 +316,10 @@ This section assumes that the name of your `teleport-kube-agent` release is

1. Check for any deployment issues by checking the updater logs:

```code
$ kubectl -n <Var name="teleport" /> logs deployment/<Var name="teleport-agent" />-updater
2023-04-28T13:13:30Z INFO StatefulSet is already up-to-date, not updating. {"controller": "statefulset", "controllerGroup": "apps", "controllerKind": "StatefulSet", "StatefulSet": {"name":"my-agent","namespace":"agent"}, "namespace": "agent", "name": "my-agent", "reconcileID": "10419f20-a4c9-45d4-a16f-406866b7fc05", "namespacedname": "agent/my-agent", "kind": "StatefulSet", "err": "no new version (current: \"v12.2.3\", next: \"v12.2.3\")"}
```
```code
$ kubectl -n <Var name="teleport" /> logs deployment/<Var name="teleport-agent" />-updater
2023-04-28T13:13:30Z INFO StatefulSet is already up-to-date, not updating. {"controller": "statefulset", "controllerGroup": "apps", "controllerKind": "StatefulSet", "StatefulSet": {"name":"my-agent","namespace":"agent"}, "namespace": "agent", "name": "my-agent", "reconcileID": "10419f20-a4c9-45d4-a16f-406866b7fc05", "namespacedname": "agent/my-agent", "kind": "StatefulSet", "err": "no new version (current: \"v12.2.3\", next: \"v12.2.3\")"}
```

## Troubleshooting

Expand Down

0 comments on commit 178c922

Please sign in to comment.