Skip to content

Use new client URLs in doc link service #219600

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 5 commits into from
May 1, 2025
Merged

Use new client URLs in doc link service #219600

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
842a4ec
Update URLs for clients in doc link service
lcawl Apr 29, 2025
ae719a5
Update URLs for serverlessClients
lcawl Apr 29, 2025
057dcbe
Merge branch 'main' into client-links
lcawl Apr 29, 2025
3ade9b8
Update URLs in plugin.test.ts
lcawl Apr 29, 2025
419a250
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
kibanamachine Apr 29, 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
102 changes: 51 additions & 51 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 @@ -913,43 +913,43 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
},
clients: {
/** Changes to these URLs must also be synched in src/platform/plugins/shared/custom_integrations/server/language_clients/index.ts */
guide: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/index.html`,
goConnecting: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/go-api/${DOC_LINK_VERSION}/connecting.html`,
goGettingStarted: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/go-api/${DOC_LINK_VERSION}/getting-started-go.html`,
goIndex: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/go-api/${DOC_LINK_VERSION}/index.html`,
goOverview: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/go-api/${DOC_LINK_VERSION}/overview.html`,
javaBasicAuthentication: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/java-api-client/${DOC_LINK_VERSION}/_basic_authentication.html`,
javaIndex: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/java-api-client/${DOC_LINK_VERSION}/index.html`,
javaInstallation: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/java-api-client/${DOC_LINK_VERSION}/installation.html`,
javaIntroduction: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/java-api-client/${DOC_LINK_VERSION}/introduction.html`,
javaRestLow: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/java-api-client/${DOC_LINK_VERSION}/java-rest-low.html`,
jsAdvancedConfig: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/javascript-api/${DOC_LINK_VERSION}/advanced-config.html`,
jsApiReference: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/javascript-api/${DOC_LINK_VERSION}/api-reference.html`,
jsBasicConfig: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/javascript-api/${DOC_LINK_VERSION}/basic-config.html`,
jsClientConnecting: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/javascript-api/${DOC_LINK_VERSION}/client-connecting.html`,
jsIntro: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/javascript-api/${DOC_LINK_VERSION}/introduction.html`,
netGuide: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/net-api/${DOC_LINK_VERSION}/index.html`,
netIntroduction: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/net-api/${DOC_LINK_VERSION}/introduction.html`,
netNest: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/net-api/${DOC_LINK_VERSION}/nest.html`,
netSingleNode: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/net-api/${DOC_LINK_VERSION}/connecting.html#single-node`,
phpConfiguration: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/php-api/${DOC_LINK_VERSION}/configuration.html`,
phpConnecting: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/php-api/${DOC_LINK_VERSION}/connecting.html`,
phpInstallation: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/php-api/${DOC_LINK_VERSION}/installation.html`,
phpGuide: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/php-api/${DOC_LINK_VERSION}/index.html`,
phpOverview: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/php-api/${DOC_LINK_VERSION}/overview.html`,
pythonAuthentication: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/python-api/${DOC_LINK_VERSION}/connecting.html#authentication`,
pythonConfig: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/python-api/${DOC_LINK_VERSION}/config.html`,
pythonConnecting: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/python-api/${DOC_LINK_VERSION}/connecting.html`,
pythonGuide: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/python-api/${DOC_LINK_VERSION}/index.html`,
pythonOverview: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/python-api/${DOC_LINK_VERSION}/overview.html`,
rubyAuthentication: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/ruby-api/${DOC_LINK_VERSION}/connecting.html#client-auth`,
rubyAdvancedConfig: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/ruby-api/${DOC_LINK_VERSION}/advanced-config.html`,
rubyBasicConfig: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/ruby-api/${DOC_LINK_VERSION}/basic-config.html`,
rubyExamples: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/ruby-api/${DOC_LINK_VERSION}/examples.html`,
rubyOverview: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/ruby-api/${DOC_LINK_VERSION}/ruby_client.html`,
rustGuide: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/rust-api/${DOC_LINK_VERSION}/index.html`,
rustOverview: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/rust-api/${DOC_LINK_VERSION}/overview.html`,
eland: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/eland/current/index.html`,
guide: `${ELASTIC_DOCS}reference/elasticsearch-clients`,
goConnecting: `${ELASTIC_DOCS}reference/elasticsearch/clients/go/connecting`,
goGettingStarted: `${ELASTIC_DOCS}reference/elasticsearch/clients/go/getting-started`,
goIndex: `${ELASTIC_DOCS}reference/elasticsearch/clients/go`,
goOverview: `${ELASTIC_DOCS}reference/elasticsearch/clients/go`,
javaBasicAuthentication: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/java-api-client/8.18/_basic_authentication.html`,
javaIndex: `${ELASTIC_DOCS}reference/elasticsearch/clients/java`,
javaInstallation: `${ELASTIC_DOCS}reference/elasticsearch/clients/java/installation`,
javaIntroduction: `${ELASTIC_DOCS}reference/elasticsearch/clients/java`,
javaRestLow: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/java-api-client/8.18/java-rest-low.html`,
jsAdvancedConfig: `${ELASTIC_DOCS}reference/elasticsearch/clients/javascript/advanced-config`,
jsApiReference: `${ELASTIC_DOCS}reference/elasticsearch/clients/javascript/api-reference`,
jsBasicConfig: `${ELASTIC_DOCS}reference/elasticsearch/clients/javascript/basic-config`,
jsClientConnecting: `${ELASTIC_DOCS}reference/elasticsearch/clients/javascript/connecting`,
jsIntro: `${ELASTIC_DOCS}reference/elasticsearch/clients/javascript`,
netGuide: `${ELASTIC_DOCS}reference/elasticsearch/clients/dotnet`,
netIntroduction: `${ELASTIC_DOCS}reference/elasticsearch/clients/dotnet`,
netNest: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/client/net-api/7.17/nest.html`,
netSingleNode: `${ELASTIC_DOCS}reference/elasticsearch/clients/dotnet/connecting#single-node`,
phpConfiguration: `${ELASTIC_DOCS}reference/elasticsearch/clients/php/configuration`,
phpConnecting: `${ELASTIC_DOCS}reference/elasticsearch/clients/php/connecting`,
phpInstallation: `${ELASTIC_DOCS}reference/elasticsearch/clients/php/installation`,
phpGuide: `${ELASTIC_DOCS}reference/elasticsearch/clients/php`,
phpOverview: `${ELASTIC_DOCS}reference/elasticsearch/clients/php`,
pythonAuthentication: `${ELASTIC_DOCS}reference/elasticsearch/clients/python/connecting#authentication`,
pythonConfig: `${ELASTIC_DOCS}reference/elasticsearch/clients/python/configuration`,
pythonConnecting: `${ELASTIC_DOCS}reference/elasticsearch/clients/python/connecting`,
pythonGuide: `${ELASTIC_DOCS}reference/elasticsearch/clients/python`,
pythonOverview: `${ELASTIC_DOCS}reference/elasticsearch/clients/python`,
rubyAuthentication: `${ELASTIC_DOCS}reference/elasticsearch/clients/ruby/connecting#client-auth`,
rubyAdvancedConfig: `${ELASTIC_DOCS}reference/elasticsearch/clients/ruby/advanced-config`,
rubyBasicConfig: `${ELASTIC_DOCS}reference/elasticsearch/clients/ruby/basic-config`,
rubyExamples: `${ELASTIC_DOCS}reference/elasticsearch/clients/ruby/examples`,
rubyOverview: `${ELASTIC_DOCS}reference/elasticsearch/clients/ruby`,
rustGuide: `${ELASTIC_DOCS}reference/elasticsearch/clients/rust`,
rustOverview: `${ELASTIC_DOCS}reference/elasticsearch/clients/rust`,
eland: `${ELASTIC_DOCS}reference/elasticsearch/clients/eland`,
},
endpoints: {
troubleshooting: `${SECURITY_SOLUTION_DOCS}ts-management.html#ts-endpoints`,
Expand All @@ -971,20 +971,20 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
elasticsearch: `${SEARCH_UI_DOCS}tutorials/elasticsearch`,
},
serverlessClients: {
clientLib: `${SERVERLESS_DOCS}elasticsearch-clients.html`,
goApiReference: `${SERVERLESS_DOCS}elasticsearch-go-client-getting-started.html`,
goGettingStarted: `${SERVERLESS_DOCS}elasticsearch-go-client-getting-started.html`,
httpApis: `${SERVERLESS_DOCS}elasticsearch-http-apis.html`,
httpApiReferences: `${SERVERLESS_DOCS}elasticsearch-http-apis.html`,
jsApiReference: `${SERVERLESS_DOCS}elasticsearch-nodejs-client-getting-started.html`,
jsGettingStarted: `${SERVERLESS_DOCS}elasticsearch-nodejs-client-getting-started.html`,
phpApiReference: `${SERVERLESS_DOCS}elasticsearch-php-client-getting-started.html`,
phpGettingStarted: `${SERVERLESS_DOCS}elasticsearch-php-client-getting-started.html`,
pythonApiReference: `${SERVERLESS_DOCS}elasticsearch-python-client-getting-started.html`,
pythonGettingStarted: `${SERVERLESS_DOCS}elasticsearch-python-client-getting-started.html`,
pythonReferences: `${SERVERLESS_DOCS}elasticsearch-python-client-getting-started.html`,
rubyApiReference: `${SERVERLESS_DOCS}elasticsearch-ruby-client-getting-started.html`,
rubyGettingStarted: `${SERVERLESS_DOCS}elasticsearch-ruby-client-getting-started.html`,
clientLib: `${ELASTIC_DOCS}reference/elasticsearch-clients`,
goApiReference: `${ELASTIC_DOCS}reference/elasticsearch/clients/go/getting-started`,
goGettingStarted: `${ELASTIC_DOCS}reference/elasticsearch/clients/go/getting-started`,
httpApis: `${ELASTIC_DOCS}deploy-manage/deploy/elastic-cloud/tools-apis`,
httpApiReferences: `${ELASTIC_DOCS}deploy-manage/deploy/elastic-cloud/tools-apis`,
jsApiReference: `${ELASTIC_DOCS}reference/elasticsearch/clients/javascript/getting-started`,
jsGettingStarted: `${ELASTIC_DOCS}reference/elasticsearch/clients/javascript/getting-started`,
phpApiReference: `${ELASTIC_DOCS}reference/elasticsearch/clients/php/getting-started`,
phpGettingStarted: `${ELASTIC_DOCS}reference/elasticsearch/clients/php/getting-started`,
pythonApiReference: `${ELASTIC_DOCS}reference/elasticsearch/clients/python/getting-started`,
pythonGettingStarted: `${ELASTIC_DOCS}reference/elasticsearch/clients/python/getting-started`,
pythonReferences: `${ELASTIC_DOCS}reference/elasticsearch/clients/python/getting-started`,
rubyApiReference: `${ELASTIC_DOCS}reference/elasticsearch/clients/ruby/getting-started`,
rubyGettingStarted: `${ELASTIC_DOCS}reference/elasticsearch/clients/ruby/getting-started`,
},
serverlessSearch: {
integrations: `${SERVERLESS_DOCS}elasticsearch-ingest-your-data.html`,
Expand Down
5 changes: 2 additions & 3 deletions src/platform/plugins/shared/custom_integrations/common/language_integrations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
import { i18n } from '@kbn/i18n';

const ELASTIC_WEBSITE_URL = 'https://www.elastic.co';
const ELASTICSEARCH_CLIENT_URL = `${ELASTIC_WEBSITE_URL}/guide/en/elasticsearch/client`;

/*
- exportLanguageUiComponent: controls whether the integration should export a UI component for language clients to Fleet UI;
Expand Down Expand Up @@ -104,7 +103,7 @@ export const languageIntegrations: LanguageIntegration[] = [
description: i18n.translate('customIntegrations.languageclients.PerlDescription', {
defaultMessage: 'Index data to Elasticsearch with the Perl client.',
}),
docUrlTemplate: `${ELASTICSEARCH_CLIENT_URL}/perl-api/{branch}/index.html`,
docUrlTemplate: `${ELASTIC_WEBSITE_URL}/guide/en/elasticsearch/client/perl-api/current/index.html`,
integrationsAppUrl: `/app/integrations/language_clients/perl/overview`,
exportLanguageUiComponent: false,
},
Expand All @@ -130,7 +129,7 @@ export const languageIntegrations: LanguageIntegration[] = [
description: i18n.translate('customIntegrations.languageclients.RustDescription', {
defaultMessage: 'Index data to Elasticsearch with the Rust client.',
}),
docUrlTemplate: `${ELASTICSEARCH_CLIENT_URL}/rust-api/{branch}/index.html`,
docUrlTemplate: `${ELASTIC_WEBSITE_URL}/docs/reference/elasticsearch/clients/rust`,
integrationsAppUrl: `/app/integrations/language_clients/rust/overview`,
exportLanguageUiComponent: false,
},
Expand Down
3 changes: 1 addition & 2 deletions src/platform/plugins/shared/custom_integrations/server/language_clients/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,7 @@ export function registerLanguageClients(
shipper: 'language_clients',
uiInternalPath: integration.exportLanguageUiComponent
? integration?.integrationsAppUrl
: // Documentation for `main` branches is still published at a `master` URL.
integration.docUrlTemplate.replace('{branch}', branch === 'main' ? 'master' : branch),
: integration.docUrlTemplate,
isBeta: false,
icons,
categories: ['elastic_stack', 'elasticsearch_sdk'],
Expand Down
5 changes: 2 additions & 3 deletions src/platform/plugins/shared/custom_integrations/server/plugin.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ describe('CustomIntegrationsPlugin', () => {
type: 'ui_link',
shipper: 'language_clients',
uiInternalPath:
'https://www.elastic.co/guide/en/elasticsearch/client/perl-api/branch/index.html',
'https://www.elastic.co/guide/en/elasticsearch/client/perl-api/current/index.html',
isBeta: false,
icons: [{ type: 'svg', src: undefined }],
categories: ['elastic_stack', 'elasticsearch_sdk'],
Expand All @@ -116,8 +116,7 @@ describe('CustomIntegrationsPlugin', () => {
description: 'Index data to Elasticsearch with the Rust client.',
type: 'ui_link',
shipper: 'language_clients',
uiInternalPath:
'https://www.elastic.co/guide/en/elasticsearch/client/rust-api/branch/index.html',
uiInternalPath: 'https://www.elastic.co/docs/reference/elasticsearch/clients/rust',
isBeta: false,
icons: [{ type: 'svg', src: undefined }],
categories: ['elastic_stack', 'elasticsearch_sdk'],
Expand Down