mirror of
https://github.com/gravitational/teleport.git
synced 2026-09-17 17:40:30 +08:00
Fix inaccurate docs URLs (#49001)
Closes #48788 Fix docs URLs in `gravitational/teleport` pages that correspond to neither: - A redirect source on the default version of the docs site - A page on the current version of the docs site In `web/packages/teleport/src/Discover/SelectResource/databases.tsx`, use literal strings instead of templated strings for docs URLs so we can check these URLs for inaccuracies.
This commit is contained in:
@@ -12,7 +12,7 @@ Here is why you might use Teleport:
|
||||
|
||||
Teleport works with SSH, Kubernetes, databases, RDP, and web services.
|
||||
|
||||
* Architecture: https://goteleport.com/docs/architecture/introduction
|
||||
* Architecture: https://goteleport.com/docs/reference/architecture/architecture
|
||||
* Getting Started: https://goteleport.com/docs/getting-started/
|
||||
|
||||
<div align="center">
|
||||
|
||||
@@ -304,7 +304,7 @@ destinations:
|
||||
},
|
||||
// Backwards compat with guides
|
||||
{
|
||||
name: "backwards compat with https://goteleport.com/docs/machine-id/guides/jenkins/",
|
||||
name: "backwards compat with https://goteleport.com/docs/enroll-resources/machine-id/deployment/jenkins/",
|
||||
input: `
|
||||
auth_server: "auth.example.com:3025"
|
||||
onboarding:
|
||||
|
||||
@@ -26,15 +26,6 @@ import { ResourceKind } from '../Shared/ResourceKind';
|
||||
|
||||
import { ResourceSpec, DatabaseLocation, DatabaseEngine } from './types';
|
||||
|
||||
enum DatabaseGuideSection {
|
||||
Aws = 'enroll-aws-databases',
|
||||
Azure = 'enroll-azure-databases',
|
||||
Gcp = 'enroll-google-cloud-databases',
|
||||
Managed = 'enroll-managed-databases',
|
||||
SelfHosted = 'enroll-self-hosted-databases',
|
||||
Guides = 'guides',
|
||||
}
|
||||
|
||||
const baseDatabaseKeywords = ['db', 'database', 'databases'];
|
||||
const awsKeywords = [...baseDatabaseKeywords, 'aws', 'amazon web services'];
|
||||
const gcpKeywords = [...baseDatabaseKeywords, 'gcp', 'google cloud platform'];
|
||||
@@ -45,10 +36,6 @@ const selfhostedKeywords = [
|
||||
];
|
||||
const azureKeywords = [...baseDatabaseKeywords, 'microsoft azure'];
|
||||
|
||||
function getDbAccessDocLink(subsection: DatabaseGuideSection, guide: string) {
|
||||
return `https://goteleport.com/docs/enroll-resources/database-access/${subsection}/${guide}`;
|
||||
}
|
||||
|
||||
// DATABASES_UNGUIDED_DOC are documentations that is not specific
|
||||
// to one type of database.
|
||||
export const DATABASES_UNGUIDED_DOC: ResourceSpec[] = [
|
||||
@@ -58,10 +45,8 @@ export const DATABASES_UNGUIDED_DOC: ResourceSpec[] = [
|
||||
keywords: [...awsKeywords, 'rds', 'proxy', 'postgresql'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'aws',
|
||||
unguidedLink: getDbAccessDocLink(
|
||||
DatabaseGuideSection.Aws,
|
||||
'rds-proxy-postgres'
|
||||
),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-aws-databases/rds-proxy-postgres',
|
||||
// TODO(lisa): add a new usage event
|
||||
event: DiscoverEventResource.DatabaseDocRdsProxy,
|
||||
},
|
||||
@@ -71,10 +56,8 @@ export const DATABASES_UNGUIDED_DOC: ResourceSpec[] = [
|
||||
keywords: [...awsKeywords, 'rds', 'proxy', 'sql server', 'sqlserver'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'aws',
|
||||
unguidedLink: getDbAccessDocLink(
|
||||
DatabaseGuideSection.Aws,
|
||||
'rds-proxy-sqlserver'
|
||||
),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-aws-databases/rds-proxy-sqlserver',
|
||||
// TODO(lisa): add a new usage event
|
||||
event: DiscoverEventResource.DatabaseDocRdsProxy,
|
||||
},
|
||||
@@ -84,10 +67,8 @@ export const DATABASES_UNGUIDED_DOC: ResourceSpec[] = [
|
||||
keywords: [...awsKeywords, 'rds', 'proxy', 'mariadb', 'mysql'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'aws',
|
||||
unguidedLink: getDbAccessDocLink(
|
||||
DatabaseGuideSection.Aws,
|
||||
'rds-proxy-mysql'
|
||||
),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-aws-databases/rds-proxy-mysql',
|
||||
// TODO(lisa): add a new usage event
|
||||
event: DiscoverEventResource.DatabaseDocRdsProxy,
|
||||
},
|
||||
@@ -97,7 +78,8 @@ export const DATABASES_UNGUIDED_DOC: ResourceSpec[] = [
|
||||
keywords: [...baseDatabaseKeywords, 'high availability', 'ha'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'database',
|
||||
unguidedLink: getDbAccessDocLink(DatabaseGuideSection.Guides, 'ha'),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/guides/ha',
|
||||
event: DiscoverEventResource.DatabaseDocHighAvailability,
|
||||
},
|
||||
{
|
||||
@@ -106,10 +88,8 @@ export const DATABASES_UNGUIDED_DOC: ResourceSpec[] = [
|
||||
keywords: [...baseDatabaseKeywords, 'dynamic registration'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'database',
|
||||
unguidedLink: getDbAccessDocLink(
|
||||
DatabaseGuideSection.Guides,
|
||||
'dynamic-registration'
|
||||
),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/guides/dynamic-registration',
|
||||
event: DiscoverEventResource.DatabaseDocDynamicRegistration,
|
||||
},
|
||||
];
|
||||
@@ -121,7 +101,8 @@ export const DATABASES_UNGUIDED: ResourceSpec[] = [
|
||||
keywords: [...awsKeywords, 'dynamodb'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'dynamo',
|
||||
unguidedLink: getDbAccessDocLink(DatabaseGuideSection.Aws, 'aws-dynamodb'),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-aws-databases/aws-dynamodb',
|
||||
event: DiscoverEventResource.DatabaseDynamoDb,
|
||||
},
|
||||
{
|
||||
@@ -130,7 +111,8 @@ export const DATABASES_UNGUIDED: ResourceSpec[] = [
|
||||
keywords: [...awsKeywords, 'elasticache', 'memorydb', 'redis'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'aws',
|
||||
unguidedLink: getDbAccessDocLink(DatabaseGuideSection.Aws, 'redis-aws'),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-aws-databases/redis-aws',
|
||||
event: DiscoverEventResource.DatabaseRedisElasticache,
|
||||
},
|
||||
{
|
||||
@@ -142,10 +124,8 @@ export const DATABASES_UNGUIDED: ResourceSpec[] = [
|
||||
keywords: [...awsKeywords, 'keyspaces', 'apache', 'cassandra'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'aws',
|
||||
unguidedLink: getDbAccessDocLink(
|
||||
DatabaseGuideSection.Aws,
|
||||
'aws-cassandra-keyspaces'
|
||||
),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-aws-databases/aws-cassandra-keyspaces',
|
||||
event: DiscoverEventResource.DatabaseCassandraKeyspaces,
|
||||
},
|
||||
{
|
||||
@@ -154,10 +134,8 @@ export const DATABASES_UNGUIDED: ResourceSpec[] = [
|
||||
keywords: [...awsKeywords, 'redshift', 'postgresql'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'redshift',
|
||||
unguidedLink: getDbAccessDocLink(
|
||||
DatabaseGuideSection.Aws,
|
||||
'postgres-redshift'
|
||||
),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-aws-databases/postgres-redshift',
|
||||
event: DiscoverEventResource.DatabasePostgresRedshift,
|
||||
},
|
||||
{
|
||||
@@ -166,10 +144,8 @@ export const DATABASES_UNGUIDED: ResourceSpec[] = [
|
||||
keywords: [...awsKeywords, 'redshift', 'serverless', 'postgresql'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'redshift',
|
||||
unguidedLink: getDbAccessDocLink(
|
||||
DatabaseGuideSection.Aws,
|
||||
'redshift-serverless'
|
||||
),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-aws-databases/redshift-serverless',
|
||||
event: DiscoverEventResource.DatabasePostgresRedshiftServerless,
|
||||
},
|
||||
{
|
||||
@@ -178,7 +154,8 @@ export const DATABASES_UNGUIDED: ResourceSpec[] = [
|
||||
keywords: [...azureKeywords, 'cache', 'redis'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'azure',
|
||||
unguidedLink: getDbAccessDocLink(DatabaseGuideSection.Azure, 'azure-redis'),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-azure-databases/azure-redis',
|
||||
event: DiscoverEventResource.DatabaseRedisAzureCache,
|
||||
},
|
||||
{
|
||||
@@ -190,10 +167,8 @@ export const DATABASES_UNGUIDED: ResourceSpec[] = [
|
||||
keywords: [...azureKeywords, 'postgresql'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'azure',
|
||||
unguidedLink: getDbAccessDocLink(
|
||||
DatabaseGuideSection.Azure,
|
||||
'azure-postgres-mysql'
|
||||
),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-azure-databases/azure-postgres-mysql',
|
||||
event: DiscoverEventResource.DatabasePostgresAzure,
|
||||
},
|
||||
{
|
||||
@@ -202,10 +177,8 @@ export const DATABASES_UNGUIDED: ResourceSpec[] = [
|
||||
keywords: [...azureKeywords, 'mysql'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'azure',
|
||||
unguidedLink: getDbAccessDocLink(
|
||||
DatabaseGuideSection.Azure,
|
||||
'azure-postgres-mysql'
|
||||
),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-azure-databases/azure-postgres-mysql',
|
||||
event: DiscoverEventResource.DatabaseMysqlAzure,
|
||||
},
|
||||
{
|
||||
@@ -224,10 +197,8 @@ export const DATABASES_UNGUIDED: ResourceSpec[] = [
|
||||
],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'azure',
|
||||
unguidedLink: getDbAccessDocLink(
|
||||
DatabaseGuideSection.Azure,
|
||||
'azure-sql-server-ad'
|
||||
),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-azure-databases/azure-sql-server-ad',
|
||||
event: DiscoverEventResource.DatabaseSqlServerAzure,
|
||||
platform: Platform.Windows,
|
||||
},
|
||||
@@ -249,7 +220,8 @@ export const DATABASES_UNGUIDED: ResourceSpec[] = [
|
||||
],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'aws',
|
||||
unguidedLink: getDbAccessDocLink(DatabaseGuideSection.Aws, 'sql-server-ad'),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-aws-databases/sql-server-ad',
|
||||
event: DiscoverEventResource.DatabaseSqlServerMicrosoft,
|
||||
platform: Platform.Windows,
|
||||
},
|
||||
@@ -259,10 +231,8 @@ export const DATABASES_UNGUIDED: ResourceSpec[] = [
|
||||
keywords: [...gcpKeywords, 'mysql'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'googlecloud',
|
||||
unguidedLink: getDbAccessDocLink(
|
||||
DatabaseGuideSection.Gcp,
|
||||
'mysql-cloudsql'
|
||||
),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-google-cloud-databases/mysql-cloudsql',
|
||||
event: DiscoverEventResource.DatabaseMysqlGcp,
|
||||
},
|
||||
{
|
||||
@@ -271,10 +241,8 @@ export const DATABASES_UNGUIDED: ResourceSpec[] = [
|
||||
keywords: [...gcpKeywords, 'postgresql'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'googlecloud',
|
||||
unguidedLink: getDbAccessDocLink(
|
||||
DatabaseGuideSection.Gcp,
|
||||
'postgres-cloudsql'
|
||||
),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-google-cloud-databases/postgres-cloudsql',
|
||||
event: DiscoverEventResource.DatabasePostgresGcp,
|
||||
},
|
||||
{
|
||||
@@ -286,10 +254,8 @@ export const DATABASES_UNGUIDED: ResourceSpec[] = [
|
||||
keywords: [...baseDatabaseKeywords, 'mongodb atlas'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'mongo',
|
||||
unguidedLink: getDbAccessDocLink(
|
||||
DatabaseGuideSection.Managed,
|
||||
'mongodb-atlas'
|
||||
),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-managed-databases/mongodb-atlas',
|
||||
event: DiscoverEventResource.DatabaseMongodbAtlas,
|
||||
},
|
||||
{
|
||||
@@ -301,10 +267,8 @@ export const DATABASES_UNGUIDED: ResourceSpec[] = [
|
||||
keywords: [...selfhostedKeywords, 'cassandra scylladb'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'selfhosted',
|
||||
unguidedLink: getDbAccessDocLink(
|
||||
DatabaseGuideSection.SelfHosted,
|
||||
'cassandra-self-hosted'
|
||||
),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-self-hosted-databases/cassandra-self-hosted',
|
||||
event: DiscoverEventResource.DatabaseCassandraSelfHosted,
|
||||
},
|
||||
{
|
||||
@@ -316,10 +280,8 @@ export const DATABASES_UNGUIDED: ResourceSpec[] = [
|
||||
keywords: [...selfhostedKeywords, 'cockroachdb'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'cockroach',
|
||||
unguidedLink: getDbAccessDocLink(
|
||||
DatabaseGuideSection.SelfHosted,
|
||||
'cockroachdb-self-hosted'
|
||||
),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-self-hosted-databases/cockroachdb-self-hosted',
|
||||
event: DiscoverEventResource.DatabaseCockroachDbSelfHosted,
|
||||
},
|
||||
{
|
||||
@@ -331,10 +293,8 @@ export const DATABASES_UNGUIDED: ResourceSpec[] = [
|
||||
keywords: [...selfhostedKeywords, 'elasticsearch', 'es'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'selfhosted',
|
||||
unguidedLink: getDbAccessDocLink(
|
||||
DatabaseGuideSection.SelfHosted,
|
||||
'elastic'
|
||||
),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-self-hosted-databases/elastic',
|
||||
event: DiscoverEventResource.DatabaseElasticSearchSelfHosted,
|
||||
},
|
||||
{
|
||||
@@ -346,10 +306,8 @@ export const DATABASES_UNGUIDED: ResourceSpec[] = [
|
||||
keywords: [...selfhostedKeywords, 'mongodb'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'mongo',
|
||||
unguidedLink: getDbAccessDocLink(
|
||||
DatabaseGuideSection.SelfHosted,
|
||||
'mongodb-self-hosted'
|
||||
),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-self-hosted-databases/mongodb-self-hosted',
|
||||
event: DiscoverEventResource.DatabaseMongodbSelfHosted,
|
||||
},
|
||||
{
|
||||
@@ -361,7 +319,8 @@ export const DATABASES_UNGUIDED: ResourceSpec[] = [
|
||||
keywords: [...selfhostedKeywords, 'redis'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'selfhosted',
|
||||
unguidedLink: getDbAccessDocLink(DatabaseGuideSection.SelfHosted, 'redis'),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-self-hosted-databases/redis',
|
||||
event: DiscoverEventResource.DatabaseRedisSelfHosted,
|
||||
},
|
||||
{
|
||||
@@ -373,10 +332,8 @@ export const DATABASES_UNGUIDED: ResourceSpec[] = [
|
||||
keywords: [...selfhostedKeywords, 'redis cluster'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'selfhosted',
|
||||
unguidedLink: getDbAccessDocLink(
|
||||
DatabaseGuideSection.SelfHosted,
|
||||
'redis-cluster'
|
||||
),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-self-hosted-databases/redis-cluster',
|
||||
event: DiscoverEventResource.DatabaseRedisClusterSelfHosted,
|
||||
},
|
||||
{
|
||||
@@ -388,7 +345,8 @@ export const DATABASES_UNGUIDED: ResourceSpec[] = [
|
||||
keywords: [...baseDatabaseKeywords, 'snowflake preview'],
|
||||
kind: ResourceKind.Database,
|
||||
icon: 'snowflake',
|
||||
unguidedLink: getDbAccessDocLink(DatabaseGuideSection.Managed, 'snowflake'),
|
||||
unguidedLink:
|
||||
'https://goteleport.com/docs/enroll-resources/database-access/enroll-managed-databases/snowflake',
|
||||
event: DiscoverEventResource.DatabaseSnowflake,
|
||||
},
|
||||
];
|
||||
|
||||
Reference in New Issue
Block a user