Skip to content

Commit

Permalink
Use new terraform-plugin-docs generator for TF reference (#43762)
Browse files Browse the repository at this point in the history
  • Loading branch information
hugoShaka authored Jul 2, 2024
1 parent 05909ce commit 3875fd4
Show file tree
Hide file tree
Showing 87 changed files with 6,136 additions and 2,939 deletions.
10 changes: 5 additions & 5 deletions api/proto/teleport/legacy/types/types.proto
Original file line number Diff line number Diff line change
Expand Up @@ -1545,13 +1545,13 @@ message ProvisionTokenSpecV2GCP {
// Rule is a set of properties the GCP-ussued token might have to be allowed
// to use this ProvisionToken.
message Rule {
// ProjectIDs is a list of project IDs (e.g. "<example-id-123456>").
// ProjectIDs is a list of project IDs (e.g. `<example-id-123456>`).
repeated string ProjectIDs = 1 [(gogoproto.jsontag) = "project_ids,omitempty"];
// Locations is a list of regions (e.g. "us-west1") and/or zones (e.g.
// "us-west1-b").
repeated string Locations = 2 [(gogoproto.jsontag) = "locations,omitempty"];
// ServiceAccounts is a list of service account emails (e.g.
// "<project-number>[email protected]").
// `<project-number>[email protected]`).
repeated string ServiceAccounts = 3 [(gogoproto.jsontag) = "service_accounts,omitempty"];
}
// Allow is a list of Rules, nodes using this token must match one
Expand Down Expand Up @@ -4494,7 +4494,7 @@ message SAMLConnectorSpecV2 {
// SSO is the URL of the identity provider's SSO service.
string SSO = 2 [(gogoproto.jsontag) = "sso"];
// Cert is the identity provider certificate PEM.
// IDP signs <Response> responses using this certificate.
// IDP signs `<Response>` responses using this certificate.
string Cert = 3 [(gogoproto.jsontag) = "cert"];
// Display controls how this connector is displayed.
string Display = 4 [(gogoproto.jsontag) = "display"];
Expand Down Expand Up @@ -4963,10 +4963,10 @@ message TrustedClusterSpecV2 {
// Token is the authorization token provided by another cluster needed by this cluster to join.
string Token = 3 [(gogoproto.jsontag) = "token"];
// ProxyAddress is the address of the web proxy server of the cluster to join. If not set,
// it is derived from <metadata.name>:<default web proxy server port>.
// it is derived from `<metadata.name>:<default web proxy server port>`.
string ProxyAddress = 4 [(gogoproto.jsontag) = "web_proxy_addr"];
// ReverseTunnelAddress is the address of the SSH proxy server of the cluster to join. If
// not set, it is derived from <metadata.name>:<default reverse tunnel port>.
// not set, it is derived from `<metadata.name>:<default reverse tunnel port>`.
string ReverseTunnelAddress = 5 [(gogoproto.jsontag) = "tunnel_addr"];
// RoleMap specifies role mappings to remote roles.
repeated RoleMapping RoleMap = 6 [
Expand Down
10 changes: 5 additions & 5 deletions api/types/types.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

162 changes: 160 additions & 2 deletions docs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -2057,8 +2057,166 @@
"slug": "/reference/metrics/"
},
{
"title": "Terraform Resources",
"slug": "/reference/terraform-provider/"
"title": "Terraform Provider",
"slug": "/reference/terraform-provider/",
"entries": [
{
"title": "Datasources",
"slug": "/reference/terraform-provider/data-sources/",
"entries": [
{
"title": "Access List",
"slug": "/reference/terraform-provider/data-sources/access_list/"
},
{
"title": "Application",
"slug": "/reference/terraform-provider/data-sources/app/"
},
{
"title": "Auth Preference",
"slug": "/reference/terraform-provider/data-sources/auth_preference/"
},
{
"title": "Cluster Maintenance Config",
"slug": "/reference/terraform-provider/data-sources/cluster_maintenance_config/"
},
{
"title": "Cluster Networking Config",
"slug": "/reference/terraform-provider/data-sources/cluster_networking_config/"
},
{
"title": "Database",
"slug": "/reference/terraform-provider/data-sources/database/"
},
{
"title": "GitHub Connector",
"slug": "/reference/terraform-provider/data-sources/github_connector/"
},
{
"title": "Login Rule",
"slug": "/reference/terraform-provider/data-sources/login_rule/"
},
{
"title": "OIDC Connector",
"slug": "/reference/terraform-provider/data-sources/oidc_connector/"
},
{
"title": "Okta Import Rule",
"slug": "/reference/terraform-provider/data-sources/okta_import_rule/"
},
{
"title": "Provision Token",
"slug": "/reference/terraform-provider/data-sources/provision_token/"
},
{
"title": "Role",
"slug": "/reference/terraform-provider/data-sources/role/"
},
{
"title": "SAML Connector",
"slug": "/reference/terraform-provider/data-sources/saml_connector/"
},
{
"title": "Session Recording Config",
"slug": "/reference/terraform-provider/data-sources/session_recording_config/"
},
{
"title": "Trusted Cluster",
"slug": "/reference/terraform-provider/data-sources/trusted_cluster/"
},
{
"title": "Trusted Device",
"slug": "/reference/terraform-provider/data-sources/trusted_device/"
},
{
"title": "User",
"slug": "/reference/terraform-provider/data-sources/user/"
}
]
},
{
"title": "Resources",
"slug": "/reference/terraform-provider/resources/",
"entries": [
{
"title": "Access List",
"slug": "/reference/terraform-provider/resources/access_list/"
},
{
"title": "Application",
"slug": "/reference/terraform-provider/resources/app/"
},
{
"title": "Auth Preference",
"slug": "/reference/terraform-provider/resources/auth_preference/"
},
{
"title": "Bot",
"slug": "/reference/terraform-provider/resources/bot/"
},
{
"title": "Cluster Maintenance Config",
"slug": "/reference/terraform-provider/resources/cluster_maintenance_config/"
},
{
"title": "Cluster Networking Config",
"slug": "/reference/terraform-provider/resources/cluster_networking_config/"
},
{
"title": "Database",
"slug": "/reference/terraform-provider/resources/database/"
},
{
"title": "GitHub Connector",
"slug": "/reference/terraform-provider/resources/github_connector/"
},
{
"title": "Login Rule",
"slug": "/reference/terraform-provider/resources/login_rule/"
},
{
"title": "OIDC Connector",
"slug": "/reference/terraform-provider/resources/oidc_connector/"
},
{
"title": "Okta Import Rule",
"slug": "/reference/terraform-provider/resources/okta_import_rule/"
},
{
"title": "Provision Token",
"slug": "/reference/terraform-provider/resources/provision_token/"
},
{
"title": "Role",
"slug": "/reference/terraform-provider/resources/role/"
},
{
"title": "SAML Connector",
"slug": "/reference/terraform-provider/resources/saml_connector/"
},
{
"title": "Server",
"slug": "/reference/terraform-provider/resources/server/"
},
{
"title": "Session Recording Config",
"slug": "/reference/terraform-provider/resources/session_recording_config/"
},
{
"title": "Trusted Cluster",
"slug": "/reference/terraform-provider/resources/trusted_cluster/"
},
{
"title": "Trusted Device",
"slug": "/reference/terraform-provider/resources/trusted_device/"
},
{
"title": "User",
"slug": "/reference/terraform-provider/resources/user/"
}
]
}
]
},
{
"title": "Audit Events and Records",
Expand Down
4 changes: 3 additions & 1 deletion docs/cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -884,6 +884,7 @@
"tenantname",
"testuser",
"tfvars",
"tfplugindocs",
"thisisunsafe",
"thred",
"timechart",
Expand Down Expand Up @@ -977,5 +978,6 @@
],
"flagWords": [
"hte"
]
],
"ignorePaths": ["**/reference/terraform-provider/**"]
}
Loading

0 comments on commit 3875fd4

Please sign in to comment.