Fix docs markup errors (#43223)

Co-authored-by: Alexey Ivanov <mail@alexeyivanov.info>
gravitational · Jun 20, 2024 · b9bacef · b9bacef
1 parent 46e1275
commit b9bacef
Show file tree

Hide file tree

Showing 11 changed files with 221 additions and 29 deletions.
diff --git a/docs/config.json b/docs/config.json
@@ -2561,16 +2561,6 @@
       "destination": "/access-controls/device-trust/device-management/",
       "permanent": true
     },
-    {
-      "source": "/management/guides/teleport-operator/",
-      "destination": "/management/dynamic-resources/teleport-operator/",
-      "permanent": true
-    },
-    {
-      "source": "/management/guides/terraform-provider/",
-      "destination": "/management/dynamic-resources/terraform-provider/",
-      "permanent": true
-    },
     {
       "source": "/get-started/",
       "destination": "/",
@@ -2623,7 +2613,7 @@
     },
     {
       "source": "/machine-id/guides/",
-      "destination": "/machine-id/",
+      "destination": "/machine-id/introduction/",
       "permanent": true
     },
     {
@@ -2661,11 +2651,6 @@
       "destination": "/machine-id/deployment/gitlab/",
       "permanent": true
     },
-    {
-      "source": "/machine-id/guides/gitlab/",
-      "destination": "/machine-id/deployment/github-actions/",
-      "permanent": true
-    },
     {
       "source": "/server-access/guides/openssh/",
       "destination": "/server-access/openssh/",

diff --git a/docs/img/IBM/IBM_HA.svg b/docs/img/IBM/IBM_HA.svg
diff --git a/docs/pages/access-controls/access-request-plugins/servicenow.mdx b/docs/pages/access-controls/access-request-plugins/servicenow.mdx
@@ -62,7 +62,7 @@ To retrieve the ServiceNow rotation ID, navigate to the group record
 of the ServiceNow group the rotation belongs to and right click on
 header, then click 'Select copy sys_id' to copy the ID.
 
-Then using the ServiceNow endpoint '/api/now/on_call_rota/workbench/group/{groupSysId}'
+Then using the ServiceNow endpoint `/api/now/on_call_rota/workbench/group/{groupSysId}`
 retrieve the group's on-call rota information.
 Select the value of the desired 'rota' from the response.
 

diff --git a/docs/pages/access-controls/login-rules/guide.mdx b/docs/pages/access-controls/login-rules/guide.mdx
@@ -17,7 +17,7 @@ cluster on version `11.3.1` or greater.
 
 Login Rules only operate on SSO logins, so make sure you have
 configured an OIDC, SAML, or GitHub connector before you begin.
-Check the [Single Sign-On](../sso/) docs to learn how to set this up.
+Check the [Single Sign-On](../sso.mdx) docs to learn how to set this up.
 
 ## Step 1/5. Configure RBAC
 

diff --git a/docs/pages/access-controls/sso/okta.mdx b/docs/pages/access-controls/sso/okta.mdx
@@ -18,7 +18,7 @@ Teleport administrators to define policies like:
 
 In Teleport Enterprise Cloud and Self-Hosted Teleport Enterprise, Teleport can
 automatically configure an SSO connector for you when as part of [enrolling the
-hosted Okta integration](../../).
+hosted Okta integration](../../index.mdx).
 
 You can enroll the Okta integration from the Teleport Web UI.
 

diff --git a/docs/pages/database-access/enroll-self-hosted-databases/cassandra-self-hosted.mdx b/docs/pages/database-access/enroll-self-hosted-databases/cassandra-self-hosted.mdx
@@ -85,7 +85,7 @@ for Cassandra, rather than the Teleport database client CA, discard
 
 ### Scylla
 
-(!docs/pages/includes/database-access/tctl-auth-sign-3-files.mdx dbName="Scylla" format="scylla" !)
+(!docs/pages/includes/database-access/tctl-auth-sign-3-files.mdx dbname="Scylla" format="scylla" !)
 
 ## Step 4/5. Configure Cassandra/Scylla
 

diff --git a/docs/pages/database-access/enroll-self-hosted-databases/clickhouse-self-hosted.mdx b/docs/pages/database-access/enroll-self-hosted-databases/clickhouse-self-hosted.mdx
@@ -64,7 +64,7 @@ choose:
 
 ## Step 2/5. Create a certificate/key pair
 
-(!docs/pages/includes/database-access/tctl-auth-sign-3-files.mdx!)
+(!docs/pages/includes/database-access/tctl-auth-sign-3-files.mdx dbname="Clickhouse" !)
 
 ## Step 3/5. Configure ClickHouse
 

diff --git a/docs/pages/database-access/enroll-self-hosted-databases/redis.mdx b/docs/pages/database-access/enroll-self-hosted-databases/redis.mdx
@@ -77,7 +77,7 @@ Install and configure Teleport where you will run the Teleport Database Service:
 
 ## Step 4/5. Set up mutual TLS
 
-(!docs/pages/includes/database-access/tctl-auth-sign-3-files.mdx format="redis" dbName="Redis" !)
+(!docs/pages/includes/database-access/tctl-auth-sign-3-files.mdx format="redis" dbname="Redis" !)
 
 You will need these files to enable mutual TLS on your Redis server.
 

diff --git a/docs/pages/management/admin/trustedclusters.mdx b/docs/pages/management/admin/trustedclusters.mdx
@@ -106,7 +106,7 @@ configured with a single sign-on identity provider that authenticates her identi
 Based on the information from the identity provider, the root cluster assigns Alice the `full-access` role
 and issues her a certificate. The mapping of single sign-on properties to Teleport roles is configured when
 you add an authentication connector to the Teleport cluster. To learn more about configuring single sign-on
-through an external identity provider, see [Configure Single Sign-on](../../access-controls/sso).
+through an external identity provider, see [Configure Single Sign-on](../../access-controls/sso.mdx).
 
 Alice receives the certificate that specifies the roles assigned to her in the root cluster. This metadata
 about her roles is contained in the certificate extensions and is protected by the signature of the root 

diff --git a/docs/pages/management/operations/db-ca-rotation.mdx b/docs/pages/management/operations/db-ca-rotation.mdx
@@ -128,7 +128,7 @@ You do not need to reconfigure databases at this point if you are rotating only
 the `db` CA, although there is no harm in doing so.
 
 Consult the appropriate
-[Teleport Database Access Guide](../../database-access/guides) for your
+[Teleport Database Access Guide](../../database-access/guides.mdx) for your
 databases before proceeding to the `update_clients` rotation phase.
 </Admonition>
 
@@ -172,7 +172,7 @@ lose access** to those databases after transitioning to the `standby` phase in
 this final step.
 
 To avoid down time, consult the appropriate
-[Teleport Database Access Guide](../../database-access/guides) and reconfigure
+[Teleport Database Access Guide](../../database-access/guides.mdx) and reconfigure
 your databases before proceeding.
 Otherwise, access may still be restored by reconfiguring your self-hosted
 databases after this step.

diff --git a/docs/pages/reference/terraform-provider.mdx b/docs/pages/reference/terraform-provider.mdx
@@ -1512,7 +1512,7 @@ Allow is a list of TokenRules, nodes using this token must match one allow rule
 | ref                   | string |          | Ref allows access to be limited to jobs triggered by a specific git ref. Ensure this is used in combination with ref_type.  This field supports simple "glob-style" matching: - Use '*' to match zero or more characters. - Use '?' to match any single character.                                                         |
 | ref_protected         | bool   |          |                                                                                                                                                                                                                                                                                                                            |
 | ref_type              | string |          | RefType allows access to be limited to jobs triggered by a specific git ref type. Example: `branch` or `tag`                                                                                                                                                                                                               |
-| sub                   | string |          | Sub roughly uniquely identifies the workload. Example: `project_path:mygroup/my-project:ref_type:branch:ref:main` project_path:{group}/{project}:ref_type:{type}:ref:{branch_name}  This field supports simple "glob-style" matching: - Use '*' to match zero or more characters. - Use '?' to match any single character. |
+| sub                   | string |          | Sub roughly uniquely identifies the workload. Example: `project_path:mygroup/my-project:ref_type:branch:ref:main project_path:{group}/{project}:ref_type:{type}:ref:{branch_name}`  This field supports simple "glob-style" matching: - Use '*' to match zero or more characters. - Use '?' to match any single character. |
 | user_email            | string |          | UserEmail is the email of the user executing the job                                                                                                                                                                                                                                                                       |
 | user_id               | string |          | UserID is the ID of the user executing the job                                                                                                                                                                                                                                                                             |
 | user_login            | string |          | UserLogin is the username of the user executing the job                                                                                                                                                                                                                                                                    |