Docs: Remove Details block from tctl partial. (#24000)

* remove details blocks in tctl partial * add bullet point when calling tctl partial * docs linter fixes
gravitational · Apr 4, 2023 · ab8ae0e · ab8ae0e
1 parent f1d8044
commit ab8ae0e
Show file tree

Hide file tree

Showing 96 changed files with 108 additions and 149 deletions.
diff --git a/docs/pages/access-controls/access-request-plugins/ssh-approval-discord.mdx b/docs/pages/access-controls/access-request-plugins/ssh-approval-discord.mdx
@@ -16,8 +16,7 @@ compromising productivity.
 - Admin account on your Discord server. Installing a bot requires at least the
   "manager server" permission.
 - Either a Linux host or Kubernetes cluster where you will run the Discord plugin.
-
-(!/docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/8. Define RBAC resources
 

diff --git a/docs/pages/access-controls/access-request-plugins/ssh-approval-email.mdx b/docs/pages/access-controls/access-request-plugins/ssh-approval-email.mdx
@@ -25,7 +25,7 @@ regularly.
 
 </Admonition>
 
-(!/docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/7. Define RBAC resources
 

diff --git a/docs/pages/access-controls/access-request-plugins/ssh-approval-jira.mdx b/docs/pages/access-controls/access-request-plugins/ssh-approval-jira.mdx
@@ -14,7 +14,7 @@ Jira tickets.
 - Jira Server or Jira Cloud installation with an owner privileges, specifically
   to set up webhooks, issue types, and workflows
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/6. Create a user and role for access
 

diff --git a/docs/pages/access-controls/access-request-plugins/ssh-approval-mattermost.mdx b/docs/pages/access-controls/access-request-plugins/ssh-approval-mattermost.mdx
@@ -16,8 +16,7 @@ compromising productivity.
 - A Mattermost account with admin privileges. This plugin has been tested with
   Mattermost v7.0.1.
 - Either a Linux host or Kubernetes cluster where you will run the Mattermost plugin.
-
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/8. Define RBAC resources
 

diff --git a/docs/pages/access-controls/access-request-plugins/ssh-approval-pagerduty.mdx b/docs/pages/access-controls/access-request-plugins/ssh-approval-pagerduty.mdx
@@ -45,7 +45,7 @@ Teleport Cloud tenant and PagerDuty.
 
 </ScopedBlock>
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/8. Create services
 

diff --git a/docs/pages/access-controls/access-requests/resource-requests.mdx b/docs/pages/access-controls/access-requests/resource-requests.mdx
@@ -28,7 +28,7 @@ available in Teleport Enterprise.
 
 (!docs/pages/includes/commercial-prereqs-tabs.mdx!)
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 <Admonition type="warning">
 All `teleport` instances in the cluster must be running Teleport `v10.0.0` or

diff --git a/docs/pages/access-controls/access-requests/role-requests.mdx b/docs/pages/access-controls/access-requests/role-requests.mdx
@@ -12,7 +12,7 @@ via ChatOps or anywhere else via our flexible Authorization Workflow API.
 
 (!docs/pages/includes/edition-prereqs-tabs.mdx!)
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## RBAC Setup
 

diff --git a/docs/pages/access-controls/getting-started.mdx b/docs/pages/access-controls/getting-started.mdx
@@ -14,9 +14,9 @@ wrap up with creating your own role.
 
 (!docs/pages/includes/edition-prereqs-tabs.mdx!)
 
-(!docs/pages/includes/permission-warning.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
-(!docs/pages/includes/tctl.mdx!)
+(!docs/pages/includes/permission-warning.mdx!)
 
 ## Step 1/3. Add local users with preset roles
 

diff --git a/docs/pages/access-controls/guides/dual-authz.mdx b/docs/pages/access-controls/guides/dual-authz.mdx
@@ -41,7 +41,7 @@ of two team members for a privileged role `dbadmin`.
 
 </Admonition>
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/3. Set up a Teleport bot
 

diff --git a/docs/pages/access-controls/guides/hardware-key-support.mdx b/docs/pages/access-controls/guides/hardware-key-support.mdx
@@ -62,7 +62,7 @@ Additionally, this feature can be configured to require touch for every Teleport
   Teleport clients use PIV slot 9a for the `hardware_key` option and 9c for the `hardware_key_touch` option, and will overwrite other keys and certs in these slots as needed. This may interfere with other PIV applications, like `yubikey-agent`, so we recommend only using one PIV application at a time.
 </Admonition>
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/2. Enforce Hardware Key Support
 

diff --git a/docs/pages/access-controls/guides/impersonation.mdx b/docs/pages/access-controls/guides/impersonation.mdx
@@ -15,7 +15,7 @@ non-interactive CI/CD user Jenkins and a security scanner.
 
 (!docs/pages/includes/edition-prereqs-tabs.mdx!)
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/3: Create a CI/CD user and corresponding role
 

diff --git a/docs/pages/access-controls/guides/locking.mdx b/docs/pages/access-controls/guides/locking.mdx
@@ -39,7 +39,7 @@ A lock can target the following objects or attributes:
 
 (!docs/pages/includes/edition-prereqs-tabs.mdx!)
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/2. Create a lock
 

diff --git a/docs/pages/access-controls/guides/per-session-mfa.mdx b/docs/pages/access-controls/guides/per-session-mfa.mdx
@@ -38,13 +38,11 @@ their on-disk Teleport certificates.
   Per-session MFA for Desktop Access was introduced in Teleport 9.
 </Details>
 
-
 ## Prerequisites
 
 (!docs/pages/includes/edition-prereqs-tabs.mdx!)
 
-(!docs/pages/includes/tctl.mdx!)
-
+- (!docs/pages/includes/tctl.mdx!)
 - [WebAuthn configured](webauthn.mdx) on this cluster
 - Second factor hardware device, such as YubiKey or SoloKey
 - A Web browser with [WebAuthn support](
@@ -64,6 +62,7 @@ teleport:
     webauthn:
       rp_id: teleport.example.com
 ```
+
 </Admonition>
 
 ## Configure per-session MFA

diff --git a/docs/pages/access-controls/guides/role-templates.mdx b/docs/pages/access-controls/guides/role-templates.mdx
@@ -20,7 +20,7 @@ other policies.
 
 (!docs/pages/includes/edition-prereqs-tabs.mdx!)
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Local users
 

diff --git a/docs/pages/access-controls/guides/webauthn.mdx b/docs/pages/access-controls/guides/webauthn.mdx
@@ -20,8 +20,7 @@ UI).
 - WebAuthn hardware device, such as YubiKey or SoloKey
 - A Web browser with [WebAuthn support](
   https://developers.yubico.com/WebAuthn/WebAuthn_Browser_Support/)
-
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/3. Enable WebAuthn support
 

diff --git a/docs/pages/access-controls/idps/saml-grafana.mdx b/docs/pages/access-controls/idps/saml-grafana.mdx
@@ -17,7 +17,7 @@ not just those running behind the Teleport App Service.
 
 (!docs/pages/includes/commercial-prereqs-tabs.mdx!)
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/3. Configure a Teleport role with access to SAML service provider objects
 

diff --git a/docs/pages/access-controls/idps/saml-guide.mdx b/docs/pages/access-controls/idps/saml-guide.mdx
@@ -13,10 +13,10 @@ authenticate to external services.
 
 (!docs/pages/includes/commercial-prereqs-tabs.mdx!)
 
-(!docs/pages/includes/tctl.mdx!)
-
+- (!docs/pages/includes/tctl.mdx!)
 - If you're new to SAML, consider reviewing our [SAML Identity Provider
 Reference](./saml-reference.mdx) before proceeding.
+
 ## Example external application
 
 We'll be using [samltest.id](https://samltest.id/) to create a test consumer of

diff --git a/docs/pages/access-controls/login-rules/guide.mdx b/docs/pages/access-controls/login-rules/guide.mdx
@@ -14,7 +14,7 @@ first Login Rule to your Teleport cluster.
 
 (!docs/pages/includes/commercial-prereqs-tabs.mdx!)
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 Before you get started you’ll need a running Teleport Enterprise or Cloud
 cluster on version `11.3.1` or greater.

diff --git a/docs/pages/access-controls/sso/adfs.mdx b/docs/pages/access-controls/sso/adfs.mdx
@@ -21,7 +21,7 @@ like:
 
 (!docs/pages/includes/commercial-prereqs-tabs.mdx!)
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 (!docs/pages/includes/enterprise/samlauthentication.mdx!)
 

diff --git a/docs/pages/access-controls/sso/azuread.mdx b/docs/pages/access-controls/sso/azuread.mdx
@@ -23,7 +23,7 @@ Before you get started you’ll need:
 
 (!docs/pages/includes/commercial-prereqs-tabs.mdx!)
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 (!docs/pages/includes/enterprise/samlauthentication.mdx!)
 

diff --git a/docs/pages/access-controls/sso/github-sso.mdx b/docs/pages/access-controls/sso/github-sso.mdx
@@ -17,7 +17,7 @@ from either GitHub Cloud or GitHub Enterprise Server.</ScopedBlock>
 
 (!docs/pages/includes/edition-prereqs-tabs.mdx!)
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/3. Create a GitHub OAuth app
 

diff --git a/docs/pages/access-controls/sso/gitlab.mdx b/docs/pages/access-controls/sso/gitlab.mdx
@@ -22,7 +22,7 @@ like:
 
 (!docs/pages/includes/commercial-prereqs-tabs.mdx!)
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Enable default OIDC authentication
 

diff --git a/docs/pages/access-controls/sso/google-workspace.mdx b/docs/pages/access-controls/sso/google-workspace.mdx
@@ -24,7 +24,7 @@ Before you get started you’ll need:
 
 (!docs/pages/includes/commercial-prereqs-tabs.mdx!)
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/4. Enable default OIDC authentication
 

diff --git a/docs/pages/access-controls/sso/oidc.mdx b/docs/pages/access-controls/sso/oidc.mdx
@@ -19,7 +19,7 @@ administrators to define policies like:
 
 (!docs/pages/includes/commercial-prereqs-tabs.mdx!)
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Enable default OIDC authentication
 

diff --git a/docs/pages/access-controls/sso/okta.mdx b/docs/pages/access-controls/sso/okta.mdx
@@ -23,8 +23,7 @@ Teleport administrators to define policies like:
 
 - A Teleport role with access to edit and maintain `saml` resources. This is
   available in the default `editor` role.
-
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 (!docs/pages/includes/enterprise/samlauthentication.mdx!)
 

diff --git a/docs/pages/access-controls/sso/one-login.mdx b/docs/pages/access-controls/sso/one-login.mdx
@@ -20,7 +20,7 @@ like:
 
 (!docs/pages/includes/commercial-prereqs-tabs.mdx!)
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 (!docs/pages/includes/enterprise/samlauthentication.mdx!)
 

diff --git a/docs/pages/api/rbac.mdx b/docs/pages/api/rbac.mdx
@@ -59,7 +59,7 @@ Teleport roles based on an external RBAC system.
 
 </Admonition>
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/4. Set up your Kubernetes cluster
 

diff --git a/docs/pages/application-access/cloud-apis/azure.mdx b/docs/pages/application-access/cloud-apis/azure.mdx
@@ -48,7 +48,7 @@ prevent unauthorized access to your organization's Azure identities.
 
   </Admonition>
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/4. Grant an identity to your VM
 

diff --git a/docs/pages/application-access/cloud-apis/google-cloud.mdx b/docs/pages/application-access/cloud-apis/google-cloud.mdx
@@ -55,7 +55,7 @@ guide.
 
 </Admonition>
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/4. Configure Google Cloud
 

diff --git a/docs/pages/application-access/getting-started.mdx b/docs/pages/application-access/getting-started.mdx
@@ -21,8 +21,7 @@ Let's connect to Grafana using Teleport Application Access in three steps:
 
 (!docs/pages/includes/edition-prereqs-tabs.mdx!)
 
-(!docs/pages/includes/tctl.mdx!)
-
+- (!docs/pages/includes/tctl.mdx!)
 - A Docker installation, which we will use to launch Grafana in a container. Alternatively, if you have another web application you'd like to protect with Application Access, you can use that instead.
 - A host where you will run the Teleport Application Service.
 

diff --git a/docs/pages/application-access/guides/dynamodb.mdx b/docs/pages/application-access/guides/dynamodb.mdx
@@ -37,7 +37,7 @@ This guide will help you to:
 
 (!docs/pages/includes/edition-prereqs-tabs.mdx!)
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 <Admonition type="tip" title="Not yet a Teleport user?">
 If you have not yet deployed the Auth Service and Proxy Service, you should follow one of our [getting started guides](../getting-started.mdx) or try our Teleport Application Access [interactive learning track](https://play.instruqt.com/teleport/invite/rgvuva4gzkon).

diff --git a/docs/pages/application-access/guides/tcp.mdx b/docs/pages/application-access/guides/tcp.mdx
@@ -11,8 +11,7 @@ servers or databases not yet natively supported in Database Access.
 
 (!docs/pages/includes/edition-prereqs-tabs.mdx!)
 
-(!docs/pages/includes/tctl.mdx!)
-
+- (!docs/pages/includes/tctl.mdx!)
 - TCP application to connect to. In this guide we'll use a PostgreSQL running
   in Docker as an example. You can also use any TCP-based application you may
   already have.

diff --git a/docs/pages/database-access/getting-started.mdx b/docs/pages/database-access/getting-started.mdx
@@ -35,7 +35,7 @@ release.
 - A host, e.g., an EC2 instance, where you will run the Teleport Database
   Service.
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/4. Set up Aurora
 

diff --git a/docs/pages/database-access/guides/aws-cassandra-keyspaces.mdx b/docs/pages/database-access/guides/aws-cassandra-keyspaces.mdx
@@ -35,7 +35,7 @@ This guide will help you to:
 - The `cqlsh` Cassandra client installed and added to your system's `PATH` environment variable.
 - A host, e.g., an Amazon EC2 instance, where you will run the Teleport Database Service.
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/5. Set up the Teleport Database Service
 

diff --git a/docs/pages/database-access/guides/aws-dynamodb.mdx b/docs/pages/database-access/guides/aws-dynamodb.mdx
@@ -32,7 +32,7 @@ This guide will help you to:
   This guide assumes an EC2 instance when creating and applying IAM roles, and
   must be adjusted accordingly for custom configurations.
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 <Admonition type="note" title="Example Access Control">
 This guide provides an example configuration of IAM access roles as a model,

diff --git a/docs/pages/database-access/guides/azure-redis.mdx b/docs/pages/database-access/guides/azure-redis.mdx
@@ -28,8 +28,7 @@ This guide will help you to:
   Service.
 - `redis-cli` version `6.2` or newer installed and added to your system's
   `PATH` environment variable.
-
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/5. Create a Teleport user
 

diff --git a/docs/pages/database-access/guides/azure-sql-server-ad.mdx b/docs/pages/database-access/guides/azure-sql-server-ad.mdx
@@ -38,8 +38,7 @@ This guide will help you to:
 
 - SQL Server running on Azure.
 - The Teleport Database Service running on an Azure virtual instance.
-
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/8. Create a Teleport user
 

diff --git a/docs/pages/database-access/guides/cassandra-self-hosted.mdx b/docs/pages/database-access/guides/cassandra-self-hosted.mdx
@@ -33,8 +33,7 @@ This guide will help you to:
 
 - Self-hosted Cassandra or ScyllaDB instance.
 - The `cqlsh` Cassandra client installed and added to your system's `PATH` environment variable.
-
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/5. Set up the Teleport Database Service
 

diff --git a/docs/pages/database-access/guides/cockroachdb-self-hosted.mdx b/docs/pages/database-access/guides/cockroachdb-self-hosted.mdx
@@ -19,7 +19,6 @@ This guide will help you to:
 2. Configure mutual TLS authentication between Teleport and your CockroachDB cluster.
 3. Connect to your CockroachDB cluster via Teleport.
 
-
 <ScopedBlock scope={["oss", "enterprise"]}>
 ![Teleport Database Access CockroachDB Self-Hosted](../../../img/database-access/guides/cockroachdb_selfhosted.png)
 </ScopedBlock>
@@ -34,8 +33,7 @@ This guide will help you to:
 - CockroachDB cluster.
 - A host, e.g., an Amazon EC2 instance, where you will run the Teleport Database
   Service.
-
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 ## Step 1/4. Set up the Teleport Database Service
 

diff --git a/docs/pages/database-access/guides/dynamic-registration.mdx b/docs/pages/database-access/guides/dynamic-registration.mdx
@@ -91,7 +91,7 @@ To create a database resource, run:
 $ tctl create database.yaml
 ```
 
-(!docs/pages/includes/tctl.mdx!)
+- (!docs/pages/includes/tctl.mdx!)
 
 After the resource has been created, it will appear among the list of available
 databases (in `tsh db ls` or UI) as long as at least one Database Service