mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 09:19:04 -04:00
[Enterprise Search] Search application connect page update doc links (#160068)
## Summary Update doc links for search api and browser client doc link --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
parent
857ca82352
commit
e7b03894f8
5 changed files with 29 additions and 19 deletions
|
@ -172,7 +172,9 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
|
|||
mailService: `${ENTERPRISE_SEARCH_DOCS}mailer-configuration.html`,
|
||||
mlDocumentEnrichment: `${ENTERPRISE_SEARCH_DOCS}document-enrichment.html`,
|
||||
searchApplicationsTemplates: `${ENTERPRISE_SEARCH_DOCS}search-applications-templates.html`,
|
||||
searchApplicationsSearchApi: `${ENTERPRISE_SEARCH_DOCS}search-applications-safe-search.html`,
|
||||
searchApplications: `${ENTERPRISE_SEARCH_DOCS}search-applications.html`,
|
||||
searchApplicationsGettingStarted: `${ENTERPRISE_SEARCH_DOCS}search-applications.html#search-applications-get-started`,
|
||||
searchTemplates: `${ELASTICSEARCH_DOCS}search-template.html`,
|
||||
start: `${ENTERPRISE_SEARCH_DOCS}start.html`,
|
||||
supportedNlpModels: `${MACHINE_LEARNING_DOCS}ml-nlp-model-ref.html`,
|
||||
|
|
|
@ -156,7 +156,9 @@ export interface DocLinks {
|
|||
readonly mailService: string;
|
||||
readonly mlDocumentEnrichment: string;
|
||||
readonly searchApplicationsTemplates: string;
|
||||
readonly searchApplicationsSearchApi: string;
|
||||
readonly searchApplications: string;
|
||||
readonly searchApplicationsGettingStarted: string;
|
||||
readonly searchTemplates: string;
|
||||
readonly start: string;
|
||||
readonly supportedNlpModels: string;
|
||||
|
|
|
@ -238,7 +238,7 @@ export const SearchApplicationAPI = () => {
|
|||
searchApiDocumentation: (
|
||||
<EuiLink
|
||||
data-test-subj="search-documentation-link"
|
||||
href="#" // replace with search api doc link
|
||||
href={docLinks.searchApplicationsSearchApi}
|
||||
data-telemetry-id="entSearchApplications-searchApi-documentation-viewDocumentaion"
|
||||
>
|
||||
{i18n.translate(
|
||||
|
@ -273,7 +273,7 @@ export const SearchApplicationAPI = () => {
|
|||
searchApiDocumentation: (
|
||||
<EuiLink
|
||||
data-test-subj="search-documentation-link"
|
||||
href="#" // replace with search api doc link
|
||||
href={docLinks.searchApplicationsSearchApi}
|
||||
target="_blank"
|
||||
data-telemetry-id="entSearchApplications-searchApi-learnMoreDocumentation-viewDocumentaion"
|
||||
>
|
||||
|
|
|
@ -98,7 +98,7 @@ export const SearchApplicationApiIntegrationStage: React.FC = () => {
|
|||
copy: false,
|
||||
language: 'http',
|
||||
title: i18n.translate(
|
||||
'xpack.enterpriseSearch.searchApplications.searchApplication.safeSearchApi.tab.apirequestTitle',
|
||||
'xpack.enterpriseSearch.searchApplications.searchApplication.searchApi.tab.apirequestTitle',
|
||||
{
|
||||
defaultMessage: 'API Request',
|
||||
}
|
||||
|
@ -109,7 +109,7 @@ export const SearchApplicationApiIntegrationStage: React.FC = () => {
|
|||
copy: true,
|
||||
language: 'javascript',
|
||||
title: i18n.translate(
|
||||
'xpack.enterpriseSearch.searchApplications.searchApplication.safeSearchApi.tab.clientTitle',
|
||||
'xpack.enterpriseSearch.searchApplications.searchApplication.searchApi.tab.clientTitle',
|
||||
{
|
||||
defaultMessage: 'Javascript Client',
|
||||
}
|
||||
|
@ -120,7 +120,7 @@ export const SearchApplicationApiIntegrationStage: React.FC = () => {
|
|||
copy: true,
|
||||
language: 'bash',
|
||||
title: i18n.translate(
|
||||
'xpack.enterpriseSearch.searchApplications.searchApplication.safeSearchApi.tab.curlTitle',
|
||||
'xpack.enterpriseSearch.searchApplications.searchApplication.searchApi.tab.curlTitle',
|
||||
{
|
||||
defaultMessage: 'cURL',
|
||||
}
|
||||
|
@ -146,13 +146,13 @@ export const SearchApplicationApiIntegrationStage: React.FC = () => {
|
|||
<EuiText>
|
||||
<p>
|
||||
<FormattedMessage
|
||||
id="xpack.enterpriseSearch.searchApplications.searchApplication.safeSearchApi.step4.description"
|
||||
id="xpack.enterpriseSearch.searchApplications.searchApplication.searchApi.step4.description"
|
||||
defaultMessage="Simplify your API calls by using one of our {clientsDocumentationLink}."
|
||||
values={{
|
||||
clientsDocumentationLink: (
|
||||
<EuiLink href={docLinks.clientsGuide}>
|
||||
{i18n.translate(
|
||||
'xpack.enterpriseSearch.searchApplications.searchApplication.safeSearchApi.step4.clientsDocumenation',
|
||||
'xpack.enterpriseSearch.searchApplications.searchApplication.searchApi.step4.clientsDocumenation',
|
||||
{
|
||||
defaultMessage: 'programming language clients',
|
||||
}
|
||||
|
@ -170,7 +170,7 @@ export const SearchApplicationApiIntegrationStage: React.FC = () => {
|
|||
key={tabId}
|
||||
isSelected={selectedTab === tabId}
|
||||
onClick={() => setSelectedTab(tabId as TabId)}
|
||||
data-telemetry-id={`entSearchApplications-safeSearchApi-integration-tab-${tabId}`}
|
||||
data-telemetry-id={`entSearchApplications-searchApi-integration-tab-${tabId}`}
|
||||
>
|
||||
{tab.title}
|
||||
</EuiTab>
|
||||
|
@ -183,7 +183,7 @@ export const SearchApplicationApiIntegrationStage: React.FC = () => {
|
|||
<EuiText>
|
||||
<h5>
|
||||
{i18n.translate(
|
||||
'xpack.enterpriseSearch.searchApplications.searchApplication.safeSearchApi.step4.installationTitle',
|
||||
'xpack.enterpriseSearch.searchApplications.searchApplication.searchApi.step4.installationTitle',
|
||||
{
|
||||
defaultMessage: 'Installation',
|
||||
}
|
||||
|
@ -195,7 +195,7 @@ export const SearchApplicationApiIntegrationStage: React.FC = () => {
|
|||
<EuiText color="inherit">
|
||||
<p>
|
||||
{i18n.translate(
|
||||
'xpack.enterpriseSearch.searchApplications.searchApplication.safeSearchApi.step4.npmInstallDescription',
|
||||
'xpack.enterpriseSearch.searchApplications.searchApplication.searchApi.step4.npmInstallDescription',
|
||||
{
|
||||
defaultMessage:
|
||||
'Search application client is accessible from NPM package registry',
|
||||
|
@ -214,7 +214,7 @@ export const SearchApplicationApiIntegrationStage: React.FC = () => {
|
|||
<EuiText color="inherit">
|
||||
<p>
|
||||
{i18n.translate(
|
||||
'xpack.enterpriseSearch.searchApplications.searchApplication.safeSearchApi.step4.cdnInstallDescription',
|
||||
'xpack.enterpriseSearch.searchApplications.searchApplication.searchApi.step4.cdnInstallDescription',
|
||||
{
|
||||
defaultMessage: 'or via CDN',
|
||||
}
|
||||
|
@ -232,7 +232,7 @@ export const SearchApplicationApiIntegrationStage: React.FC = () => {
|
|||
<EuiText color="inherit">
|
||||
<h5>
|
||||
{i18n.translate(
|
||||
'xpack.enterpriseSearch.searchApplications.searchApplication.safeSearchApi.step4.clientUsageTitle',
|
||||
'xpack.enterpriseSearch.searchApplications.searchApplication.searchApi.step4.clientUsageTitle',
|
||||
{
|
||||
defaultMessage: 'Usage',
|
||||
}
|
||||
|
@ -243,14 +243,13 @@ export const SearchApplicationApiIntegrationStage: React.FC = () => {
|
|||
<EuiFlexItem>
|
||||
<EuiText>
|
||||
<FormattedMessage
|
||||
id="xpack.enterpriseSearch.searchApplications.searchApplication.safeSearchApi.step4.clientUsageDescription"
|
||||
defaultMessage="To get the most out of the client, use the javascript client's example template and follow our {searchapplicationClientDocLink} on building a search experience."
|
||||
id="xpack.enterpriseSearch.searchApplications.searchApplication.searchApi.step4.clientUsageDescription"
|
||||
defaultMessage="To get the most out of the client, use the javascript client's example template and follow our {searchapplicationGettingStartedDocLink} on building a search experience."
|
||||
values={{
|
||||
searchapplicationClientDocLink: (
|
||||
// replace # with search application client doc link
|
||||
<EuiLink href="#">
|
||||
searchapplicationGettingStartedDocLink: (
|
||||
<EuiLink href={docLinks.searchApplicationsGettingStarted}>
|
||||
{i18n.translate(
|
||||
'xpack.enterpriseSearch.searchApplications.searchApplication.safeSearchApi.step3.clientDocumenation',
|
||||
'xpack.enterpriseSearch.searchApplications.searchApplication.searchApi.step3.clientDocumenation',
|
||||
{
|
||||
defaultMessage: 'how to guide',
|
||||
}
|
||||
|
@ -273,7 +272,7 @@ export const SearchApplicationApiIntegrationStage: React.FC = () => {
|
|||
<EuiFlexGroup direction="column" alignItems="flexEnd">
|
||||
<EuiLink href={consolePreviewLink} target="_blank">
|
||||
<FormattedMessage
|
||||
id="xpack.enterpriseSearch.searchApplications.searchApplication.safeSearchApi.step4.apiRequestConsoleButton"
|
||||
id="xpack.enterpriseSearch.searchApplications.searchApplication.searchApi.step4.apiRequestConsoleButton"
|
||||
defaultMessage="Try in console"
|
||||
/>
|
||||
</EuiLink>
|
||||
|
|
|
@ -113,7 +113,9 @@ class DocLinks {
|
|||
public queryDsl: string;
|
||||
public rrf: string;
|
||||
public searchApplications: string;
|
||||
public searchApplicationsGettingStarted: string;
|
||||
public searchApplicationsTemplates: string;
|
||||
public searchApplicationsSearchApi: string;
|
||||
public searchTemplates: string;
|
||||
public searchUIAppSearch: string;
|
||||
public searchUIElasticsearch: string;
|
||||
|
@ -267,6 +269,8 @@ class DocLinks {
|
|||
this.searchUIElasticsearch = '';
|
||||
this.searchApplicationsTemplates = '';
|
||||
this.searchApplications = '';
|
||||
this.searchApplicationsGettingStarted = '';
|
||||
this.searchApplicationsSearchApi = '';
|
||||
this.searchTemplates = '';
|
||||
this.start = '';
|
||||
this.supportedNlpModels = '';
|
||||
|
@ -419,7 +423,10 @@ class DocLinks {
|
|||
this.searchUIAppSearch = docLinks.links.searchUI.appSearch;
|
||||
this.searchUIElasticsearch = docLinks.links.searchUI.elasticsearch;
|
||||
this.searchApplicationsTemplates = docLinks.links.enterpriseSearch.searchApplicationsTemplates;
|
||||
this.searchApplicationsSearchApi = docLinks.links.enterpriseSearch.searchApplicationsSearchApi;
|
||||
this.searchApplications = docLinks.links.enterpriseSearch.searchApplications;
|
||||
this.searchApplicationsGettingStarted =
|
||||
docLinks.links.enterpriseSearch.searchApplicationsGettingStarted;
|
||||
this.searchTemplates = docLinks.links.enterpriseSearch.searchTemplates;
|
||||
this.start = docLinks.links.enterpriseSearch.start;
|
||||
this.supportedNlpModels = docLinks.links.enterpriseSearch.supportedNlpModels;
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue