From 44ee59930313ecc785aecca3710706ff8dc115bd Mon Sep 17 00:00:00 2001 From: Steven Martin Date: Fri, 6 Sep 2024 16:41:04 -0400 Subject: [PATCH] docs: use code styling instead of shell (#46356) Co-authored-by: Steven Martin --- .../machine-id/workload-identity/federation.mdx | 4 ++-- .../helm-reference/zz_generated.teleport-operator.mdx | 2 +- examples/chart/teleport-cluster/README.md | 2 +- .../chart/teleport-cluster/charts/teleport-operator/README.md | 2 +- .../teleport-cluster/charts/teleport-operator/values.yaml | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/pages/enroll-resources/machine-id/workload-identity/federation.mdx b/docs/pages/enroll-resources/machine-id/workload-identity/federation.mdx index bb1a5a5c560f9..dae54d5f7ea55 100644 --- a/docs/pages/enroll-resources/machine-id/workload-identity/federation.mdx +++ b/docs/pages/enroll-resources/machine-id/workload-identity/federation.mdx @@ -89,7 +89,7 @@ trust domain according to the refresh hint provided by the remote trust domain. You can check the status of the federation relationship using the `tctl` CLI: -```shell +```code $ tctl get spiffe_federation/example.com ``` @@ -109,4 +109,4 @@ Identity in Production. - Read the [configuration reference](../../../reference/machine-id/configuration.mdx) to explore all the available configuration options. - Read the [SPIFFE Federation Specification](https://github.com/spiffe/spiffe/blob/main/standards/SPIFFE_Federation.md) -to understand the technical details of SPIFFE Federation. \ No newline at end of file +to understand the technical details of SPIFFE Federation. diff --git a/docs/pages/includes/helm-reference/zz_generated.teleport-operator.mdx b/docs/pages/includes/helm-reference/zz_generated.teleport-operator.mdx index b85bd428813c3..8fce50395c01d 100644 --- a/docs/pages/includes/helm-reference/zz_generated.teleport-operator.mdx +++ b/docs/pages/includes/helm-reference/zz_generated.teleport-operator.mdx @@ -304,7 +304,7 @@ To use this value, you must create a Kubernetes `Secret` containing the CA certs in the same namespace as the Teleport Kubernetes Operator using a command such as: -```shell +```code $ kubectl create secret generic my-root-ca --from-file=ca.pem=/path/to/root-ca.pem ``` diff --git a/examples/chart/teleport-cluster/README.md b/examples/chart/teleport-cluster/README.md index b239357c525b5..4a10a17ec3403 100644 --- a/examples/chart/teleport-cluster/README.md +++ b/examples/chart/teleport-cluster/README.md @@ -45,7 +45,7 @@ or by installing [cert-manager](https://cert-manager.io/docs/) and setting the ` The first user can be created by executing a command in one of the auth pods. -```shell +```code kubectl exec it -n teleport-cluster statefulset/teleport-cluster-auth -- tctl users add my-username --roles=editor,auditor,access ``` diff --git a/examples/chart/teleport-cluster/charts/teleport-operator/README.md b/examples/chart/teleport-cluster/charts/teleport-operator/README.md index d0b87ed49af44..8755e8cc112d3 100644 --- a/examples/chart/teleport-cluster/charts/teleport-operator/README.md +++ b/examples/chart/teleport-cluster/charts/teleport-operator/README.md @@ -13,7 +13,7 @@ operator version is deployed, use the `--version` Helm flag. The chart can be deployed in two ways: - in standalone mode by running - ```shell + ```code helm install teleport/teleport-operator teleport-operator --set authAddr=teleport.example.com:443 --set token=my-operator-token ``` See [the standalone guide](https://goteleport.com/docs/management/dynamic-resources/teleport-operator-standalone/) for more details. diff --git a/examples/chart/teleport-cluster/charts/teleport-operator/values.yaml b/examples/chart/teleport-cluster/charts/teleport-operator/values.yaml index 0a5bbefed9c0d..f576b26ce68df 100644 --- a/examples/chart/teleport-cluster/charts/teleport-operator/values.yaml +++ b/examples/chart/teleport-cluster/charts/teleport-operator/values.yaml @@ -180,7 +180,7 @@ tls: # certs in the same namespace as the Teleport Kubernetes Operator using a # command such as: # - # ```shell + # ```code # $ kubectl create secret generic my-root-ca --from-file=ca.pem=/path/to/root-ca.pem # ``` existingCASecretName: ""