Skip to content

Commit

Permalink
Markup shell session snippets as console
Browse files Browse the repository at this point in the history
This change replaces "bash" with "console" as the Markdown code fence keyword. This lets Markdown engines differentiate between the shell command and its output, with a leading $ (or # or >) denoting a command and the rest is just text output with no syntax highlighting.

Signed-off-by: Andreas Lindhé <7773090+lindhe@users.noreply.github.com>
  • Loading branch information
lindhe authored Jul 10, 2024
1 parent 8ad50e6 commit 94725cf
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions content/docs/installation/kubectl.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ you'll need to make modifications to the deployment manifests.
Once you've installed cert-manager, you can verify it is deployed correctly by
checking the `cert-manager` namespace for running pods:

```bash
```console
$ kubectl get pods --namespace cert-manager

NAME READY STATUS RESTARTS AGE
Expand All @@ -55,15 +55,15 @@ First, make sure that [cmctl is installed](../reference/cmctl.md#installation).
cmctl performs a dry-run certificate creation check against the Kubernetes cluster.
If successful, the message `The cert-manager API is ready` is displayed.

```bash
```console
$ cmctl check api
The cert-manager API is ready
```

The command can also be used to wait for the check to be successful.
Here is an output example of running the command at the same time that cert-manager is being installed:

```bash
```console
$ cmctl check api --wait=2m
Not ready: the cert-manager CRDs are not yet installed on the Kubernetes API server
Not ready: the cert-manager CRDs are not yet installed on the Kubernetes API server
Expand Down Expand Up @@ -116,7 +116,8 @@ $ kubectl apply -f test-resources.yaml

Check the status of the newly created certificate. You may need to wait a few
seconds before cert-manager processes the certificate request.
```bash

```console
$ kubectl describe certificate -n cert-manager-test

...
Expand All @@ -140,6 +141,7 @@ Events:
```

Clean up the test resources.

```bash
$ kubectl delete -f test-resources.yaml
```
Expand Down

0 comments on commit 94725cf

Please sign in to comment.