Skip to content

Use new enterpriseSearch URLs in link service #219290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lcawl merged 9 commits into from
Apr 28, 2025
Merged

Use new enterpriseSearch URLs in link service #219290

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
bce2624
Use new enterpriseSearch URLs in link service
lcawl Apr 25, 2025
73782f2
Merge branch 'main' into search-links
lcawl Apr 25, 2025
40a329d
Re-add variables
lcawl Apr 25, 2025
87f2107
Re-add ESRE_DOCS variable
lcawl Apr 25, 2025
c5bd5df
Re-add ELASTICSEARCH_DOCS
lcawl Apr 25, 2025
b2d65f6
Merge branch 'main' into search-links
lcawl Apr 25, 2025
8ffdc62
Fix typo
lcawl Apr 25, 2025
0a34a28
Merge branch 'main' into search-links
lcawl Apr 28, 2025
1668ccd
Update src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts
lcawl Apr 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 61 additions & 62 deletions src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
const ENTERPRISE_SEARCH_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/enterprise-search/${DOC_LINK_VERSION}/`;
const ESRE_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/esre/${DOC_LINK_VERSION}/`;
const SEARCH_UI_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/search-ui/current/`;
const MACHINE_LEARNING_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/`;
const SERVERLESS_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/serverless/current/`;
const SEARCH_LABS_REPO = `${ELASTIC_GITHUB}elasticsearch-labs/`;
const isServerless = buildFlavor === 'serverless';
Expand Down Expand Up @@ -129,55 +128,55 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
enterpriseSearch: {
aiSearchDoc: `${ESRE_DOCS}`,
aiSearchHelp: `${ESRE_DOCS}help.html`,
apiKeys: `${KIBANA_DOCS}api-keys.html`,
apiKeys: `${ELASTIC_DOCS}deploy-manage/api-keys/elasticsearch-api-keys`,
behavioralAnalytics: `${ELASTICSEARCH_DOCS}behavioral-analytics-overview.html`,
behavioralAnalyticsCORS: `${ELASTICSEARCH_DOCS}behavioral-analytics-cors.html`,
behavioralAnalyticsEvents: `${ELASTICSEARCH_DOCS}behavioral-analytics-event.html`,
buildConnector: `${ELASTICSEARCH_DOCS}es-build-connector.html`,
buildConnector: `${ELASTIC_DOCS}reference/search-connectors/self-managed-connectors`,
bulkApi: isServerless
? `${ELASTICSEARCH_SERVERLESS_APIS}operation/operation-bulk`
: `${ELASTICSEARCH_APIS}operation/operation-bulk`,
configuration: `${ENTERPRISE_SEARCH_DOCS}configuration.html`,
connectors: `${ELASTICSEARCH_DOCS}es-connectors.html`,
connectorsClientDeploy: `${ELASTICSEARCH_DOCS}es-build-connector.html#es-connectors-deploy-connector-service`,
connectorsMappings: `${ELASTICSEARCH_DOCS}es-connectors-usage.html#es-connectors-usage-index-create-configure-existing-index`,
connectorsAzureBlobStorage: `${ELASTICSEARCH_DOCS}es-connectors-azure-blob.html`,
connectorsBox: `${ELASTICSEARCH_DOCS}es-connectors-box.html`,
connectorsClients: `${ELASTICSEARCH_DOCS}es-connectors.html#es-connectors-build`,
connectorsConfluence: `${ELASTICSEARCH_DOCS}es-connectors-confluence.html`,
connectorsDropbox: `${ELASTICSEARCH_DOCS}es-connectors-dropbox.html`,
connectorsContentExtraction: `${ELASTICSEARCH_DOCS}es-connectors-content-extraction.html`,
connectorsGithub: `${ELASTICSEARCH_DOCS}es-connectors-github.html`,
connectorsGmail: `${ELASTICSEARCH_DOCS}es-connectors-gmail.html`,
connectorsGoogleCloudStorage: `${ELASTICSEARCH_DOCS}es-connectors-google-cloud.html`,
connectorsGoogleDrive: `${ELASTICSEARCH_DOCS}es-connectors-google-drive.html`,
connectorsJira: `${ELASTICSEARCH_DOCS}es-connectors-jira.html`,
connectorsMicrosoftSQL: `${ELASTICSEARCH_DOCS}es-connectors-ms-sql.html`,
connectorsMongoDB: `${ELASTICSEARCH_DOCS}es-connectors-mongodb.html`,
connectorsMySQL: `${ELASTICSEARCH_DOCS}es-connectors-mysql.html`,
connectorsNative: `${ELASTICSEARCH_DOCS}es-connectors.html#es-connectors-native`,
connectorsNetworkDrive: `${ELASTICSEARCH_DOCS}es-connectors-network-drive.html`,
connectorsNotion: `${ELASTICSEARCH_DOCS}es-connectors-notion.html`,
connectorsOneDrive: `${ELASTICSEARCH_DOCS}es-connectors-onedrive.html`,
connectorsOracle: `${ELASTICSEARCH_DOCS}es-connectors-oracle.html`,
connectorsOutlook: `${ELASTICSEARCH_DOCS}es-connectors-outlook.html`,
connectorsPostgreSQL: `${ELASTICSEARCH_DOCS}es-connectors-postgresql.html`,
connectorsRedis: `${ELASTICSEARCH_DOCS}es-connectors-redis.html`,
connectorsS3: `${ELASTICSEARCH_DOCS}es-connectors-s3.html`,
connectorsSalesforce: `${ELASTICSEARCH_DOCS}es-connectors-salesforce.html`,
connectorsServiceNow: `${ELASTICSEARCH_DOCS}es-connectors-servicenow.html`,
connectorsSharepoint: `${ELASTICSEARCH_DOCS}es-connectors-sharepoint.html`,
connectorsSharepointOnline: `${ELASTICSEARCH_DOCS}es-connectors-sharepoint-online.html`,
connectorsSlack: `${ELASTICSEARCH_DOCS}es-connectors-slack.html`,
connectorsTeams: `${ELASTICSEARCH_DOCS}es-connectors-teams.html`,
connectorsZoom: `${ELASTICSEARCH_DOCS}es-connectors-zoom.html`,
connectors: `${ELASTIC_DOCS}reference/search-connectors`,
connectorsClientDeploy: `${ELASTIC_DOCS}reference/search-connectors/self-managed-connectors#es-connectors-deploy-connector-service`,
connectorsMappings: `${ELASTIC_DOCS}reference/search-connectors/connectors-ui-in-kibana#es-connectors-usage-index-create-configure-existing-index`,
connectorsAzureBlobStorage: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-azure-blob`,
connectorsBox: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-box`,
connectorsClients: `${ELASTIC_DOCS}reference/search-connectors`,
connectorsConfluence: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-confluence`,
connectorsDropbox: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-dropbox`,
connectorsContentExtraction: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-content-extraction`,
connectorsGithub: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-github`,
connectorsGmail: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-gmail`,
connectorsGoogleCloudStorage: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-google-cloud`,
connectorsGoogleDrive: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-google-drive`,
connectorsJira: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-jira`,
connectorsMicrosoftSQL: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-ms-sql`,
connectorsMongoDB: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-mongodb`,
connectorsMySQL: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-mysql`,
connectorsNative: `${ELASTIC_DOCS}reference/search-connectors#es-connectors-native`,
connectorsNetworkDrive: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-network-drive`,
connectorsNotion: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-notion`,
connectorsOneDrive: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-onedrive`,
connectorsOracle: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-oracle`,
connectorsOutlook: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-outlook`,
connectorsPostgreSQL: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-postgresql`,
connectorsRedis: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-redis`,
connectorsS3: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-s3`,
connectorsSalesforce: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-salesforce`,
connectorsServiceNow: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-servicenow`,
connectorsSharepoint: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-sharepoint`,
connectorsSharepointOnline: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-sharepoint-online`,
connectorsSlack: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-slack`,
connectorsTeams: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-teams`,
connectorsZoom: `${ELASTIC_DOCS}reference/search-connectors/es-connectors-zoom`,
crawlerExtractionRules: `${ENTERPRISE_SEARCH_DOCS}crawler-extraction-rules.html`,
crawlerManaging: `${ENTERPRISE_SEARCH_DOCS}crawler-managing.html`,
crawlerOverview: `${ENTERPRISE_SEARCH_DOCS}crawler.html`,
deployTrainedModels: `${MACHINE_LEARNING_DOCS}ml-nlp-deploy-models.html`,
documentLevelSecurity: `${ELASTICSEARCH_DOCS}document-level-security.html`,
e5Model: `${MACHINE_LEARNING_DOCS}ml-nlp-e5.html`,
elser: `${ELASTICSEARCH_DOCS}semantic-search-semantic-text.html`,
deployTrainedModels: `${ELASTIC_DOCS}explore-analyze/machine-learning/nlp/ml-nlp-deploy-models`,
documentLevelSecurity: `${ELASTIC_DOCS}deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level`,
e5Model: `${ELASTIC_DOCS}explore-analyze/machine-learning/nlp/ml-nlp-e5`,
elser: `${ELASTIC_DOCS}solutions/search/semantic-search/semantic-search-semantic-text`,
engines: `${ENTERPRISE_SEARCH_DOCS}engines.html`,
indexApi: isServerless
? `${ELASTICSEARCH_SERVERLESS_APIS}operation/operation-create`
Expand All @@ -186,31 +185,31 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
? `${ELASTICSEARCH_SERVERLESS_APIS}operation/operation-inference-put`
: `${ELASTICSEARCH_APIS}operation/operation-inference-put`,
inferenceApisConfigureChunking: `${ELASTIC_DOCS}explore-analyze/elastic-inference/inference-api#infer-chunking-config`,
ingestionApis: `${ELASTICSEARCH_DOCS}search-with-elasticsearch.html`,
ingestPipelines: `${ELASTICSEARCH_DOCS}ingest-pipeline-search.html`,
knnSearch: `${ELASTICSEARCH_DOCS}knn-search.html`,
knnSearchCombine: `${ELASTICSEARCH_DOCS}knn-search.html#_combine_approximate_knn_with_other_features`,
languageAnalyzers: `${ELASTICSEARCH_DOCS}analysis-lang-analyzer.html`,
ingestionApis: `${ELASTIC_DOCS}solutions/search`,
ingestPipelines: `${ELASTIC_DOCS}solutions/search/search-pipelines`,
knnSearch: `${ELASTIC_DOCS}solutions/search/vector/knn`,
knnSearchCombine: `${ELASTIC_DOCS}solutions/search/vector/knn#_combine_approximate_knn_with_other_features`,
languageAnalyzers: `${ELASTIC_DOCS}reference/text-analysis/analysis-lang-analyzer`,
languageClients: `${ENTERPRISE_SEARCH_DOCS}programming-language-clients.html`,
licenseManagement: `${ENTERPRISE_SEARCH_DOCS}license-management.html`,
machineLearningStart: `${ELASTICSEARCH_DOCS}nlp-example.html`,
machineLearningStart: `${ELASTIC_DOCS}explore-analyze/machine-learning/nlp/nlp-end-to-end-tutorial`,
mailService: `${ENTERPRISE_SEARCH_DOCS}mailer-configuration.html`,
mlDocumentEnrichment: `${ELASTICSEARCH_DOCS}ingest-pipeline-search-inference.html`,
searchApplicationsTemplates: `${ELASTICSEARCH_DOCS}search-application-api.html`,
searchApplicationsSearchApi: `${ELASTICSEARCH_DOCS}search-application-security.html`,
searchApplications: `${ELASTICSEARCH_DOCS}search-application-overview.html`,
searchApplicationsSearch: `${ELASTICSEARCH_DOCS}search-application-client.html`,
mlDocumentEnrichment: `${ELASTIC_DOCS}explore-analyze/machine-learning/machine-learning-in-kibana/inference-processing`,
searchApplicationsTemplates: `${ELASTIC_DOCS}solutions/search/search-applications/search-application-api`,
searchApplicationsSearchApi: `${ELASTIC_DOCS}solutions/search/search-applications/search-application-security`,
searchApplications: `${ELASTIC_DOCS}solutions/search/search-applications`,
searchApplicationsSearch: `${ELASTIC_DOCS}solutions/search/search-applications/search-application-client`,
searchLabs: `${SEARCH_LABS_URL}`,
searchLabsRepo: `${SEARCH_LABS_REPO}`,
semanticSearch: `${ELASTICSEARCH_DOCS}semantic-search.html`,
searchTemplates: `${ELASTICSEARCH_DOCS}search-template.html`,
semanticTextField: `${ELASTICSEARCH_DOCS}semantic-text.html`,
semanticSearch: `${ELASTIC_DOCS}solutions/search/semantic-search`,
searchTemplates: `${ELASTIC_DOCS}solutions/search/search-templates`,
semanticTextField: `${ELASTIC_DOCS}reference/elasticsearch/mapping-reference/semantic-text`,
start: `${ENTERPRISE_SEARCH_DOCS}start.html`,
supportedNlpModels: `${MACHINE_LEARNING_DOCS}ml-nlp-model-ref.html`,
syncRules: `${ELASTICSEARCH_DOCS}es-sync-rules.html`,
syncRulesAdvanced: `${ELASTICSEARCH_DOCS}es-sync-rules.html#es-sync-rules-advanced`,
trainedModels: `${MACHINE_LEARNING_DOCS}ml-trained-models.html`,
textEmbedding: `${MACHINE_LEARNING_DOCS}ml-nlp-model-ref.html#ml-nlp-model-ref-text-embedding`,
supportedNlpModels: `${ELASTIC_DOCS}explore-analyze/machine-learning/nlp/ml-nlp-model-ref`,
syncRules: `${ELASTIC_DOCS}reference/search-connectors/es-sync-rules`,
syncRulesAdvanced: `${ELASTIC_DOCS}reference/search-connectors/es-sync-rules#es-sync-rules-advanced`,
trainedModels: `${ELASTIC_DOCS}explore-analyze/machine-learning/data-frame-analytics/ml-trained-models`,
textEmbedding: `${ELASTIC_DOCS}explore-analyze/machine-learning/nlp/ml-nlp-model-ref#ml-nlp-model-ref-text-embedding`,
troubleshootSetup: `${ENTERPRISE_SEARCH_DOCS}troubleshoot-setup.html`,
upgrade9x: `${ENTERPRISE_SEARCH_DOCS}upgrading-to-9-x.html`,
usersAccess: `${ENTERPRISE_SEARCH_DOCS}users-access.html`,
Expand Down Expand Up @@ -562,9 +561,9 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
nlpImportModel: `${ELASTIC_DOCS}explore-analyze/machine-learning/nlp/ml-nlp-import-model`,
},
transforms: {
guide: `https://www.elastic.co/docs/explore-analyze/transforms`,
alertingRules: `https://www.elastic.co/docs/explore-analyze/transforms/transform-alerts`,
overview: `https://www.elastic.co/docs/explore-analyze/transforms/transform-overview`,
guide: `${ELASTIC_DOCS}explore-analyze/transforms`,
alertingRules: `${ELASTIC_DOCS}explore-analyze/transforms/transform-alerts`,
overview: `${ELASTIC_DOCS}explore-analyze/transforms/transform-overview`,
},
visualize: {
guide: `${KIBANA_DOCS}_panels_and_visualizations.html`,
Expand Down