Explicit that TF reference is generated (#44667) (#44688)

* Add comment warning that tf ref is generated * trigger CI on TF ref changes
gravitational · Jul 26, 2024 · 21c777c · 21c777c
1 parent 6a42b1f
commit 21c777c
Show file tree

Hide file tree

Showing 45 changed files with 134 additions and 0 deletions.
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -58,6 +58,8 @@ jobs:
               - 'integrations/terraform/Makefile'
               - 'integrations/terraform/examples/**'
               - 'integrations/terraform/templates/**'
+              # rendered doc changes
+              - 'docs/pages/reference/terraform-provider/**'
 
   lint-go:
     name: Lint (Go)

diff --git a/docs/pages/reference/terraform-provider.mdx b/docs/pages/reference/terraform-provider.mdx
@@ -3,6 +3,9 @@ title: "Teleport Terraform Provider"
 description: Reference documentation of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 The Teleport Terraform provider allows Terraform users to configure Teleport
 from Terraform.
 

diff --git a/docs/pages/reference/terraform-provider/data-sources.mdx b/docs/pages/reference/terraform-provider/data-sources.mdx
@@ -3,6 +3,9 @@ title: "Terraform data-sources index"
 description: "Index of all the data-sources supported by the Teleport Terraform Provider"
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 {/*
     This file will be renamed data-sources.mdx during build time.
     The template name is reserved by tfplugindocs so we suffix with -index.

diff --git a/docs/pages/reference/terraform-provider/data-sources/access_list.mdx b/docs/pages/reference/terraform-provider/data-sources/access_list.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_access_list Terraform data-source
 description: This page describes the supported values of the teleport_access_list data-source of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/app.mdx b/docs/pages/reference/terraform-provider/data-sources/app.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_app Terraform data-source
 description: This page describes the supported values of the teleport_app data-source of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/auth_preference.mdx b/docs/pages/reference/terraform-provider/data-sources/auth_preference.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_auth_preference Terraform data-source
 description: This page describes the supported values of the teleport_auth_preference data-source of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 

diff --git a/.../pages/reference/terraform-provider/data-sources/cluster_maintenance_config.mdx b/.../pages/reference/terraform-provider/data-sources/cluster_maintenance_config.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_cluster_maintenance_config Terraform data-sour
 description: This page describes the supported values of the teleport_cluster_maintenance_config data-source of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/cluster_networking_config.mdx b/docs/pages/reference/terraform-provider/data-sources/cluster_networking_config.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_cluster_networking_config Terraform data-sourc
 description: This page describes the supported values of the teleport_cluster_networking_config data-source of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/database.mdx b/docs/pages/reference/terraform-provider/data-sources/database.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_database Terraform data-source
 description: This page describes the supported values of the teleport_database data-source of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/github_connector.mdx b/docs/pages/reference/terraform-provider/data-sources/github_connector.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_github_connector Terraform data-source
 description: This page describes the supported values of the teleport_github_connector data-source of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/login_rule.mdx b/docs/pages/reference/terraform-provider/data-sources/login_rule.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_login_rule Terraform data-source
 description: This page describes the supported values of the teleport_login_rule data-source of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/oidc_connector.mdx b/docs/pages/reference/terraform-provider/data-sources/oidc_connector.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_oidc_connector Terraform data-source
 description: This page describes the supported values of the teleport_oidc_connector data-source of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/okta_import_rule.mdx b/docs/pages/reference/terraform-provider/data-sources/okta_import_rule.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_okta_import_rule Terraform data-source
 description: This page describes the supported values of the teleport_okta_import_rule data-source of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/provision_token.mdx b/docs/pages/reference/terraform-provider/data-sources/provision_token.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_provision_token Terraform data-source
 description: This page describes the supported values of the teleport_provision_token data-source of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/role.mdx b/docs/pages/reference/terraform-provider/data-sources/role.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_role Terraform data-source
 description: This page describes the supported values of the teleport_role data-source of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/saml_connector.mdx b/docs/pages/reference/terraform-provider/data-sources/saml_connector.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_saml_connector Terraform data-source
 description: This page describes the supported values of the teleport_saml_connector data-source of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/session_recording_config.mdx b/docs/pages/reference/terraform-provider/data-sources/session_recording_config.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_session_recording_config Terraform data-source
 description: This page describes the supported values of the teleport_session_recording_config data-source of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/trusted_cluster.mdx b/docs/pages/reference/terraform-provider/data-sources/trusted_cluster.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_trusted_cluster Terraform data-source
 description: This page describes the supported values of the teleport_trusted_cluster data-source of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/trusted_device.mdx b/docs/pages/reference/terraform-provider/data-sources/trusted_device.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_trusted_device Terraform data-source
 description: This page describes the supported values of the teleport_trusted_device data-source of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 

diff --git a/docs/pages/reference/terraform-provider/data-sources/user.mdx b/docs/pages/reference/terraform-provider/data-sources/user.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_user Terraform data-source
 description: This page describes the supported values of the teleport_user data-source of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 

diff --git a/docs/pages/reference/terraform-provider/resources.mdx b/docs/pages/reference/terraform-provider/resources.mdx
@@ -3,6 +3,9 @@ title: "Terraform resources index"
 description: "Index of all the datasources supported by the Teleport Terraform Provider"
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 {/*
     This file will be renamed data-sources.mdx during build time.
     The template name is reserved by tfplugindocs so we suffix with -index.

diff --git a/docs/pages/reference/terraform-provider/resources/access_list.mdx b/docs/pages/reference/terraform-provider/resources/access_list.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_access_list Terraform resource
 description: This page describes the supported values of the teleport_access_list resource of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 ## Example Usage

diff --git a/docs/pages/reference/terraform-provider/resources/app.mdx b/docs/pages/reference/terraform-provider/resources/app.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_app Terraform resource
 description: This page describes the supported values of the teleport_app resource of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 ## Example Usage

diff --git a/docs/pages/reference/terraform-provider/resources/auth_preference.mdx b/docs/pages/reference/terraform-provider/resources/auth_preference.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_auth_preference Terraform resource
 description: This page describes the supported values of the teleport_auth_preference resource of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 ## Example Usage

diff --git a/docs/pages/reference/terraform-provider/resources/bot.mdx b/docs/pages/reference/terraform-provider/resources/bot.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_bot Terraform resource
 description: This page describes the supported values of the teleport_bot resource of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 ## Example Usage

diff --git a/docs/pages/reference/terraform-provider/resources/cluster_maintenance_config.mdx b/docs/pages/reference/terraform-provider/resources/cluster_maintenance_config.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_cluster_maintenance_config Terraform resource
 description: This page describes the supported values of the teleport_cluster_maintenance_config resource of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 ## Example Usage

diff --git a/docs/pages/reference/terraform-provider/resources/cluster_networking_config.mdx b/docs/pages/reference/terraform-provider/resources/cluster_networking_config.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_cluster_networking_config Terraform resource
 description: This page describes the supported values of the teleport_cluster_networking_config resource of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 ## Example Usage

diff --git a/docs/pages/reference/terraform-provider/resources/database.mdx b/docs/pages/reference/terraform-provider/resources/database.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_database Terraform resource
 description: This page describes the supported values of the teleport_database resource of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 ## Example Usage

diff --git a/docs/pages/reference/terraform-provider/resources/github_connector.mdx b/docs/pages/reference/terraform-provider/resources/github_connector.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_github_connector Terraform resource
 description: This page describes the supported values of the teleport_github_connector resource of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 ## Example Usage

diff --git a/docs/pages/reference/terraform-provider/resources/login_rule.mdx b/docs/pages/reference/terraform-provider/resources/login_rule.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_login_rule Terraform resource
 description: This page describes the supported values of the teleport_login_rule resource of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 ## Example Usage

diff --git a/docs/pages/reference/terraform-provider/resources/oidc_connector.mdx b/docs/pages/reference/terraform-provider/resources/oidc_connector.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_oidc_connector Terraform resource
 description: This page describes the supported values of the teleport_oidc_connector resource of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 ## Example Usage

diff --git a/docs/pages/reference/terraform-provider/resources/okta_import_rule.mdx b/docs/pages/reference/terraform-provider/resources/okta_import_rule.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_okta_import_rule Terraform resource
 description: This page describes the supported values of the teleport_okta_import_rule resource of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 ## Example Usage

diff --git a/docs/pages/reference/terraform-provider/resources/provision_token.mdx b/docs/pages/reference/terraform-provider/resources/provision_token.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_provision_token Terraform resource
 description: This page describes the supported values of the teleport_provision_token resource of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 ## Example Usage

diff --git a/docs/pages/reference/terraform-provider/resources/role.mdx b/docs/pages/reference/terraform-provider/resources/role.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_role Terraform resource
 description: This page describes the supported values of the teleport_role resource of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 ## Example Usage

diff --git a/docs/pages/reference/terraform-provider/resources/saml_connector.mdx b/docs/pages/reference/terraform-provider/resources/saml_connector.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_saml_connector Terraform resource
 description: This page describes the supported values of the teleport_saml_connector resource of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 ## Example Usage

diff --git a/docs/pages/reference/terraform-provider/resources/server.mdx b/docs/pages/reference/terraform-provider/resources/server.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_server Terraform resource
 description: This page describes the supported values of the teleport_server resource of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 ## Example Usage

diff --git a/docs/pages/reference/terraform-provider/resources/session_recording_config.mdx b/docs/pages/reference/terraform-provider/resources/session_recording_config.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_session_recording_config Terraform resource
 description: This page describes the supported values of the teleport_session_recording_config resource of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 ## Example Usage

diff --git a/docs/pages/reference/terraform-provider/resources/trusted_cluster.mdx b/docs/pages/reference/terraform-provider/resources/trusted_cluster.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_trusted_cluster Terraform resource
 description: This page describes the supported values of the teleport_trusted_cluster resource of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 ## Example Usage

diff --git a/docs/pages/reference/terraform-provider/resources/trusted_device.mdx b/docs/pages/reference/terraform-provider/resources/trusted_device.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_trusted_device Terraform resource
 description: This page describes the supported values of the teleport_trusted_device resource of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 ## Example Usage

diff --git a/docs/pages/reference/terraform-provider/resources/user.mdx b/docs/pages/reference/terraform-provider/resources/user.mdx
@@ -3,6 +3,9 @@ title: Reference for the teleport_user Terraform resource
 description: This page describes the supported values of the teleport_user resource of the Teleport Terraform provider.
 ---
 
+{/*Auto-generated file. Do not edit.*/}
+{/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
+
 
 
 ## Example Usage
-Original file line number
+Diff line change
@@ Expand Up @@
     description: This page describes the supported values of the teleport_access_list data-source of the Teleport Terraform provider.
     ---
+    {/*Auto-generated file. Do not edit.*/}
+    {/*To regenerate, navigate to integrations/terraform and run `make docs`.*/}
@@ Expand Down @@