Fix outdated docs URLs

- Web UI source - README - lib - api Do not touch docs URLs in test case names or test data where we don't expect users to navigate to the URLs.
gravitational · Jan 10, 2025 · a49234a · a49234a
1 parent e10b956
commit a49234a
Show file tree

Hide file tree

Showing 46 changed files with 100 additions and 102 deletions.
diff --git a/README.md b/README.md
@@ -12,8 +12,8 @@ Here is why you might use Teleport:
 
 Teleport works with SSH, Kubernetes, databases, RDP, and web services.
 
-* Architecture: https://goteleport.com/docs/reference/architecture/architecture
-* Getting Started: https://goteleport.com/docs/getting-started/
+* Architecture: https://goteleport.com/docs/reference/architecture/
+* Getting Started: https://goteleport.com/docs/get-started/
 
 <div align="center">
    <a href="https://goteleport.com/download">
@@ -62,7 +62,7 @@ We have implemented Teleport as a single Go binary that integrates with multiple
 * [Windows Hosts](https://goteleport.com/docs/enroll-resources/desktop-access/introduction/).
 * [Networked servers](https://goteleport.com/docs/enroll-resources/server-access/introduction/).
 
-You can set up Teleport as a [Linux daemon](https://goteleport.com/docs/deploy-a-cluster/linux-demo) or a [Kubernetes deployment](https://goteleport.com/docs/deploy-a-cluster/helm-deployments/).
+You can set up Teleport as a [Linux daemon](https://goteleport.com/docs/admin-guides/deploy-a-cluster/linux-demo) or a [Kubernetes deployment](https://goteleport.com/docs/admin-guides/deploy-a-cluster/helm-deployments/).
 
 Teleport focuses on best practices for infrastructure security:
 
@@ -98,7 +98,7 @@ deployment that makes it easier to enable secure access to your infrastructure.
 Cloud.
 
 Follow our guide to [registering your first
-server](https://goteleport.com/docs/choose-an-edition/teleport-cloud/get-started/)
+server](https://goteleport.com/docs/get-started/)
 with Teleport Enterprise Cloud.
 
 ## Docker
@@ -357,10 +357,10 @@ We had a choice, either start a security consulting business or build a solution
 
 ## More Information
 
-* [Teleport Getting Started](https://goteleport.com/docs/getting-started/)
+* [Teleport Getting Started](https://goteleport.com/docs/get-started/)
 * [Teleport
   Architecture](https://goteleport.com/teleport/docs/architecture/introduction)
-* [Reference](https://goteleport.com/docs/reference/introduction)
+* [Reference](https://goteleport.com/docs/reference/)
 * [FAQ](https://goteleport.com/docs/faq)
 
 ## Support and Contributing

diff --git a/api/client/README.md b/api/client/README.md
@@ -2,9 +2,9 @@ This package is documented using a combination of [pkg.go.dev](https://pkg.go.de
 
 ## Reference
 
-- [Introduction](https://goteleport.com/docs/reference/api/introduction/)
-- [Getting Started](https://goteleport.com/docs/reference/api/getting-started/)
-- [Architecture](https://goteleport.com/docs/reference/api/architecture/)
+- [Introduction](https://goteleport.com/docs/admin-guides/api/)
+- [Getting Started](https://goteleport.com/docs/admin-guides/api/getting-started/)
+- [Architecture](https://goteleport.com/docs/reference/architecture/api-architecture/)
 - [pkg.go.dev](https://pkg.go.dev/github.com/gravitational/teleport/api/client/)
   - [Using the client](https://pkg.go.dev/github.com/gravitational/teleport/api/client#Client/)
   - [Working with credentials](https://pkg.go.dev/github.com/gravitational/teleport/api/client#Credentials/)
diff --git a/api/types/authentication.go b/api/types/authentication.go
@@ -414,7 +414,7 @@ func (c *AuthPreferenceV2) SetConnectorName(cn string) {
 // GetU2F gets the U2F configuration settings.
 func (c *AuthPreferenceV2) GetU2F() (*U2F, error) {
 	if c.Spec.U2F == nil {
-		return nil, trace.NotFound("U2F is not configured in this cluster, please contact your administrator and ask them to follow https://goteleport.com/docs/access-controls/guides/u2f/")
+		return nil, trace.NotFound("U2F is not configured in this cluster")
 	}
 	return c.Spec.U2F, nil
 }
@@ -426,7 +426,7 @@ func (c *AuthPreferenceV2) SetU2F(u2f *U2F) {
 
 func (c *AuthPreferenceV2) GetWebauthn() (*Webauthn, error) {
 	if c.Spec.Webauthn == nil {
-		return nil, trace.NotFound("Webauthn is not configured in this cluster, please contact your administrator and ask them to follow https://goteleport.com/docs/access-controls/guides/webauthn/")
+		return nil, trace.NotFound("Webauthn is not configured in this cluster, please contact your administrator and ask them to follow https://goteleport.com/docs/admin-guides/access-controls/guides/webauthn/")
 	}
 	return c.Spec.Webauthn, nil
 }
@@ -718,7 +718,7 @@ func (c *AuthPreferenceV2) CheckAndSetDefaults() error {
 		const deprecationMessage = `` +
 			`Second Factor "u2f" is deprecated and marked for removal, using "webauthn" instead. ` +
 			`Please update your configuration to use WebAuthn. ` +
-			`Refer to https://goteleport.com/docs/access-controls/guides/webauthn/`
+			`Refer to https://goteleport.com/docs/admin-guides/access-controls/guides/webauthn/`
 		slog.WarnContext(context.Background(), deprecationMessage)
 		c.Spec.SecondFactor = constants.SecondFactorWebauthn
 	case "":

diff --git a/lib/auth/auth_with_roles.go b/lib/auth/auth_with_roles.go
@@ -5470,7 +5470,7 @@ func (a *ServerWithRoles) GenerateSnowflakeJWT(ctx context.Context, req *proto.S
 				"user", a.context.User.GetName(),
 				"error", err,
 			)
-			return nil, trace.AccessDenied(`access denied. The user must be able to impersonate the builtin role and user "Db" in order to generate database certificates, for more info see https://goteleport.com/docs/database-access/reference/cli/#tctl-auth-sign.`)
+			return nil, trace.AccessDenied(`access denied. The user must be able to impersonate the builtin role and user "Db" in order to generate database certificates, for more info see https://goteleport.com/docs/reference/agent-services/database-access-reference/cli/#tctl-auth-sign.`)
 		}
 	}
 	return a.authServer.GenerateSnowflakeJWT(ctx, req)

diff --git a/lib/auth/init.go b/lib/auth/init.go
@@ -731,7 +731,7 @@ func initializeAuthority(ctx context.Context, asrv *Server, caID types.CertAuthI
 	if numKeyTypes > 1 {
 		const msg = "CA contains a combination of key types. If you are attempting to" +
 			" configure HSM or KMS key storage, make sure it is configured on all auth servers in" +
-			" this cluster and then perform a CA rotation: https://goteleport.com/docs/management/operations/ca-rotation/"
+			" this cluster and then perform a CA rotation: https://goteleport.com/docs/admin-guides/management/operations/ca-rotation/"
 		asrv.logger.WarnContext(ctx, msg,
 			"ca_type", caID.Type,
 			"key_types", []string{strings.Join(allKeyTypes[:numKeyTypes-1], ", "), allKeyTypes[numKeyTypes-1]},
@@ -783,7 +783,7 @@ auth_service:
       rp_id: example.com
 
 For more information:
-- https://goteleport.com/docs/access-controls/guides/webauthn/
+- https://goteleport.com/docs/admin-guides/access-controls/guides/webauthn/
 `
 
 func initializeAuthPreference(ctx context.Context, asrv *Server, newAuthPref types.AuthPreference) error {

diff --git a/lib/auth/rotate.go b/lib/auth/rotate.go
@@ -625,7 +625,7 @@ func (a *Server) syncUsableKeysAlert(ctx context.Context, usableKeysResults map[
 		msg += "The Auth Service will continue signing certificates with raw software keys. "
 	}
 	msg += "These CAs must be rotated to begin using the configured key type. " +
-		"See https://goteleport.com/docs/management/operations/ca-rotation/"
+		"See https://goteleport.com/docs/admin-guides/management/operations/ca-rotation/"
 
 	alert, err := types.NewClusterAlert("ca-key-types/"+a.ServerID, msg, alertOptions...)
 	if err != nil {

diff --git a/lib/client/db/dbcmd/error.go b/lib/client/db/dbcmd/error.go
@@ -52,7 +52,7 @@ func ConvertCommandError(cmd *exec.Cmd, err error, peakStderr string) error {
 	if strings.Contains(lowerCaseStderr, "access to db denied") {
 		fmtString := "%v: '%s' exited with the above error. Use 'tsh db ls' to see your available logins, " +
 			"or ask your Teleport administrator to grant you access." +
-			"\nSee https://goteleport.com/docs/database-access/troubleshooting/#access-to-db-denied for more information."
+			"\nSee https://goteleport.com/docs/enroll-resources/database-access/troubleshooting/#access-to-db-denied for more information."
 		return trace.AccessDenied(fmtString, err, cmd.Path)
 	}
 	return trace.Wrap(err)

diff --git a/lib/config/configuration_test.go b/lib/config/configuration_test.go
@@ -2648,7 +2648,7 @@ func TestAppsCLF(t *testing.T) {
 			outApps:   nil,
 			requireError: func(t require.TestingT, err error, i ...interface{}) {
 				require.True(t, trace.IsBadParameter(err))
-				require.ErrorContains(t, err, "application name \"-foo\" must be a valid DNS subdomain: https://goteleport.com/docs/application-access/guides/connecting-apps/#application-name")
+				require.ErrorContains(t, err, "application name \"-foo\" must be a valid DNS subdomain: https://goteleport.com/docs/enroll-resources/application-access/guides/connecting-apps/#application-name")
 			},
 		},
 		{

diff --git a/lib/config/database.go b/lib/config/database.go
@@ -43,7 +43,7 @@ var databaseConfigTemplateFuncs = template.FuncMap{
 // databaseAgentConfigurationTemplate database configuration template.
 var databaseAgentConfigurationTemplate = template.Must(template.New("").Funcs(databaseConfigTemplateFuncs).Parse(`#
 # Teleport database agent configuration file.
-# Configuration reference: https://goteleport.com/docs/database-access/reference/configuration/
+# Configuration reference: https://goteleport.com/docs/reference/agent-services/database-access-reference/configuration/
 #
 version: v3
 teleport:
@@ -62,7 +62,7 @@ db_service:
   enabled: true
 
   # Matchers for database resources created with "tctl create" command or by the discovery service.
-  # For more information about dynamic registration: https://goteleport.com/docs/database-access/guides/dynamic-registration/
+  # For more information about dynamic registration: https://goteleport.com/docs/enroll-resources/database-access/guides/dynamic-registration/
   {{- if .DynamicResourcesLabels }}
   resources:
   {{- range $index, $resourceLabel := .DynamicResourcesLabels }}
@@ -97,12 +97,7 @@ db_service:
   aws:
   {{- else }}
   # For more information about AWS auto-discovery:
-  # RDS/Aurora: https://goteleport.com/docs/database-access/guides/rds/
-  # RDS Proxy: https://goteleport.com/docs/database-access/guides/rdsproxy/
-  # Redshift: https://goteleport.com/docs/database-access/guides/postgres-redshift/
-  # Redshift Serverless: https://goteleport.com/docs/database-access/guides/postgres-redshift-serverless/
-  # ElastiCache/MemoryDB: https://goteleport.com/docs/database-access/guides/redis-aws/
-  # OpenSearch: https://goteleport.com/docs/database-access/guides/aws-opensearch/
+  # https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
   #
   # aws:
   #   # Database types. Valid options are:
@@ -122,7 +117,7 @@ db_service:
   {{- end }}
   {{- if .RDSDiscoveryRegions }}
   # RDS/Aurora databases auto-discovery.
-  # For more information about RDS/Aurora auto-discovery: https://goteleport.com/docs/database-access/guides/rds/
+  # For more information about RDS/Aurora auto-discovery: https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
   - types: ["rds"]
     # AWS regions to register databases from.
     regions:
@@ -137,7 +132,7 @@ db_service:
   {{- end }}
   {{- if .RDSProxyDiscoveryRegions }}
   # RDS Proxies auto-discovery.
-  # For more information about RDS Proxy auto-discovery: https://goteleport.com/docs/database-access/guides/rdsproxy/
+  # For more information about RDS Proxy auto-discovery: https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
   - types: ["rdsproxy"]
     # AWS regions to register databases from.
     regions:
@@ -152,7 +147,7 @@ db_service:
   {{- end }}
   {{- if .RedshiftDiscoveryRegions }}
   # Redshift databases auto-discovery.
-  # For more information about Redshift auto-discovery: https://goteleport.com/docs/database-access/guides/postgres-redshift/
+  # For more information about Redshift auto-discovery: https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
   - types: ["redshift"]
     # AWS regions to register databases from.
     regions:
@@ -167,7 +162,7 @@ db_service:
   {{- end }}
   {{- if .RedshiftServerlessDiscoveryRegions }}
   # Redshift Serverless databases auto-discovery.
-  # For more information about Redshift Serverless auto-discovery: https://goteleport.com/docs/database-access/guides/postgres-redshift-serverless/
+  # For more information about Redshift Serverless auto-discovery: https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
   - types: ["redshift-serverless"]
     # AWS regions to register databases from.
     regions:
@@ -182,7 +177,7 @@ db_service:
   {{- end }}
   {{- if .ElastiCacheDiscoveryRegions }}
   # ElastiCache databases auto-discovery.
-  # For more information about ElastiCache auto-discovery: https://goteleport.com/docs/database-access/guides/redis-aws/
+  # For more information about ElastiCache auto-discovery: https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
   - types: ["elasticache"]
     # AWS regions to register databases from.
     regions:
@@ -197,7 +192,7 @@ db_service:
   {{- end }}
   {{- if .MemoryDBDiscoveryRegions }}
   # MemoryDB databases auto-discovery.
-  # For more information about MemoryDB auto-discovery: https://goteleport.com/docs/database-access/guides/redis-aws/
+  # For more information about MemoryDB auto-discovery: https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
   - types: ["memorydb"]
     # AWS regions to register databases from.
     regions:
@@ -212,7 +207,7 @@ db_service:
   {{- end }}
   {{- if .OpenSearchDiscoveryRegions }}
   # OpenSearch databases auto-discovery.
-  # For more information about OpenSearch auto-discovery: https://goteleport.com/docs/database-access/guides/aws-opensearch/
+  # For more information about OpenSearch auto-discovery: https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
   - types: ["opensearch"]
     # AWS regions to register databases from.
     regions:
@@ -231,9 +226,9 @@ db_service:
   azure:
   {{- else }}
   # For more information about Azure auto-discovery:
-  # MySQL/PostgreSQL: https://goteleport.com/docs/database-access/guides/azure-postgres-mysql/
-  # Redis: https://goteleport.com/docs/database-access/guides/azure-redis/
-  # SQL Server: https://goteleport.com/docs/database-access/guides/azure-sql-server-ad/
+  # MySQL/PostgreSQL: https://goteleport.com/docs/enroll-resources/database-access/enroll-azure-databases/azure-postgres-mysql/
+  # Redis: https://goteleport.com/docs/enroll-resources/database-access/enroll-azure-databases/azure-redis/
+  # SQL Server: https://goteleport.com/docs/enroll-resources/database-access/enroll-azure-databases/azure-sql-server-ad/
   #
   # azure:
   #   # Database types. Valid options are:
@@ -257,7 +252,7 @@ db_service:
   {{- end }}
   {{- if or .AzureMySQLDiscoveryRegions }}
   # Azure MySQL databases auto-discovery.
-  # For more information about Azure MySQL auto-discovery: https://goteleport.com/docs/database-access/guides/azure-postgres-mysql/
+  # For more information about Azure MySQL auto-discovery: https://goteleport.com/docs/enroll-resources/database-access/enroll-azure-databases/azure-postgres-mysql/
   - types: ["mysql"]
     # Azure subscription IDs to match.
     subscriptions:
@@ -282,7 +277,7 @@ db_service:
   {{- end }}
   {{- if or .AzurePostgresDiscoveryRegions }}
   # Azure Postgres databases auto-discovery.
-  # For more information about Azure Postgres auto-discovery: https://goteleport.com/docs/database-access/guides/azure-postgres-mysql/
+  # For more information about Azure Postgres auto-discovery: https://goteleport.com/docs/enroll-resources/database-access/enroll-azure-databases/azure-postgres-mysql/
   - types: ["postgres"]
     # Azure subscription IDs to match.
     subscriptions:
@@ -307,7 +302,7 @@ db_service:
   {{- end }}
   {{- if or .AzureRedisDiscoveryRegions }}
   # Azure Cache For Redis databases auto-discovery.
-  # For more information about Azure Cache for Redis auto-discovery: https://goteleport.com/docs/database-access/guides/azure-redis/
+  # For more information about Azure Cache for Redis auto-discovery: https://goteleport.com/docs/enroll-resources/database-access/enroll-azure-databases/azure-redis/
   - types: ["redis"]
     # Azure subscription IDs to match.
     subscriptions:
@@ -332,7 +327,7 @@ db_service:
   {{- end }}
   {{- if or .AzureSQLServerDiscoveryRegions }}
   # Azure SQL server and Managed instances auto-discovery.
-  # For more information about SQL server and Managed instances auto-discovery: https://goteleport.com/docs/database-access/guides/azure-sql-server-ad/
+  # For more information about SQL server and Managed instances auto-discovery: https://goteleport.com/docs/enroll-resources/database-access/enroll-azure-databases/azure-sql-server-ad/
   - types: ["sqlserver"]
     # Azure subscription IDs to match.
     subscriptions:
@@ -453,7 +448,7 @@ db_service:
   #
   # databases:
   # # RDS database static configuration.
-  # # RDS/Aurora databases Auto-discovery reference: https://goteleport.com/docs/database-access/guides/rds/
+  # # RDS/Aurora databases Auto-discovery guide: https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
   # - name: rds
   #   description: AWS RDS/Aurora instance configuration example.
   #   # Supported protocols for RDS/Aurora: "postgres" or "mysql"
@@ -469,7 +464,7 @@ db_service:
   #       # RDS Instance ID. Only present on RDS databases.
   #       instance_id: rds-instance-1
   # # Aurora database static configuration.
-  # # RDS/Aurora databases Auto-discovery reference: https://goteleport.com/docs/database-access/guides/rds/
+  # # RDS/Aurora databases Auto-discovery guide: https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
   # - name: aurora
   #   description: AWS Aurora cluster configuration example.
   #   # Supported protocols for RDS/Aurora: "postgres" or "mysql"
@@ -485,7 +480,7 @@ db_service:
   #       # Aurora Cluster ID. Only present on Aurora databases.
   #       cluster_id: aurora-cluster-1
   # # Redshift database static configuration.
-  # # For more information: https://goteleport.com/docs/database-access/guides/postgres-redshift/
+  # # For more information: https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
   # - name: redshift
   #   description: AWS Redshift cluster configuration example.
   #   # Supported protocols for Redshift: "postgres".

diff --git a/lib/config/fileconf.go b/lib/config/fileconf.go
@@ -1166,7 +1166,7 @@ func (w *Webauthn) Parse() (*types.Webauthn, error) {
 	if w.Disabled {
 		const msg = `The "webauthn.disabled" setting is marked for removal and currently has no effect. ` +
 			`Please update your configuration to use WebAuthn. ` +
-			`Refer to https://goteleport.com/docs/access-controls/guides/webauthn/`
+			`Refer to https://goteleport.com/docs/admin-guides/access-controls/guides/webauthn/`
 		slog.WarnContext(context.Background(), msg)
 	}
 	return &types.Webauthn{

diff --git a/lib/devicetrust/native/device_linux.go b/lib/devicetrust/native/device_linux.go
@@ -113,7 +113,7 @@ func rewriteTPMPermissionError(err error) error {
 	return errors.New("" +
 		"Failed to open the TPM device. " +
 		"Consider assigning the user to the `tss` group or creating equivalent udev rules. " +
-		"See https://goteleport.com/docs/access-controls/device-trust/device-management/#troubleshooting.")
+		"See https://goteleport.com/docs/admin-guides/access-controls/device-trust/device-management/#troubleshooting.")
 }
 
 // cddFuncs is used to mock various data collection functions for testing.

diff --git a/lib/integrations/azureoidc/provision_sso.go b/lib/integrations/azureoidc/provision_sso.go
@@ -31,7 +31,8 @@ func setupSSO(ctx context.Context, graphClient *msgraph.Client, appObjectID stri
 	preferredSingleSignOnMode := "saml"
 	spPatch.PreferredSingleSignOnMode = &preferredSingleSignOnMode
 	// Do not require explicit assignment of the app to use SSO.
-	// This is per our manual set-up recommendations, see https://goteleport.com/docs/access-controls/sso/azuread/ .
+	// This is per our manual set-up recommendations, see
+	// https://goteleport.com/docs/admin-guides/access-controls/sso/azuread/ .
 	appRoleAssignmentRequired := false
 	spPatch.AppRoleAssignmentRequired = &appRoleAssignmentRequired