[8.9] [Search Application] Connect page : update search application search doc link and minor wording (#161220) (#161262)

# Backport

This will backport the following commits from `main` to `8.9`:
- [[Search Application] Connect page : update search application search
doc link and minor wording
(#161220)](https://github.com/elastic/kibana/pull/161220)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Saarika
Bhasi","email":"55930906+saarikabhasi@users.noreply.github.com"},"sourceCommit":{"committedDate":"2023-07-05T14:07:26Z","message":"[Search
Application] Connect page : update search application search doc link
and minor wording (#161220)\n\n## Summary\r\n\r\n* Change UI wording
from API Request to **Console** and minor wording\r\nchange\r\n* Make
`how to guide` url in javascript client tab to point to
[Search\r\napplication
search\r\ndoc](https://www.elastic.co/guide/en/enterprise-search/master/search-applications-search.html\r\n)\r\n\r\nRelated\r\n[discussion](https://elastic.slack.com/archives/C02U50QNEAG/p1688394299778629)\r\n\r\n##
Screen
Recording\r\n\r\n\r\n8c6482c0-68b2-4374-87b4-fcf6305e5bc2","sha":"679573bfd5f60f998f3396822cd019870bed5995","branchLabelMapping":{"^v8.10.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v8.9.0","v8.10.0"],"number":161220,"url":"https://github.com/elastic/kibana/pull/161220","mergeCommit":{"message":"[Search
Application] Connect page : update search application search doc link
and minor wording (#161220)\n\n## Summary\r\n\r\n* Change UI wording
from API Request to **Console** and minor wording\r\nchange\r\n* Make
`how to guide` url in javascript client tab to point to
[Search\r\napplication
search\r\ndoc](https://www.elastic.co/guide/en/enterprise-search/master/search-applications-search.html\r\n)\r\n\r\nRelated\r\n[discussion](https://elastic.slack.com/archives/C02U50QNEAG/p1688394299778629)\r\n\r\n##
Screen
Recording\r\n\r\n\r\n8c6482c0-68b2-4374-87b4-fcf6305e5bc2","sha":"679573bfd5f60f998f3396822cd019870bed5995"}},"sourceBranch":"main","suggestedTargetBranches":["8.9"],"targetPullRequestStates":[{"branch":"8.9","label":"v8.9.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.10.0","labelRegex":"^v8.10.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/161220","number":161220,"mergeCommit":{"message":"[Search
Application] Connect page : update search application search doc link
and minor wording (#161220)\n\n## Summary\r\n\r\n* Change UI wording
from API Request to **Console** and minor wording\r\nchange\r\n* Make
`how to guide` url in javascript client tab to point to
[Search\r\napplication
search\r\ndoc](https://www.elastic.co/guide/en/enterprise-search/master/search-applications-search.html\r\n)\r\n\r\nRelated\r\n[discussion](https://elastic.slack.com/archives/C02U50QNEAG/p1688394299778629)\r\n\r\n##
Screen
Recording\r\n\r\n\r\n8c6482c0-68b2-4374-87b4-fcf6305e5bc2","sha":"679573bfd5f60f998f3396822cd019870bed5995"}}]}]
BACKPORT-->

Co-authored-by: Saarika Bhasi <55930906+saarikabhasi@users.noreply.github.com>
This commit is contained in:
Kibana Machine 2023-07-05 11:13:02 -04:00 committed by GitHub
parent 298f467450
commit f2f32e0ae2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 14 additions and 27 deletions

View file

@ -176,7 +176,7 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
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`,
searchApplicationsSearch: `${ENTERPRISE_SEARCH_DOCS}search-applications-search.html`,
searchTemplates: `${ELASTICSEARCH_DOCS}search-template.html`,
start: `${ENTERPRISE_SEARCH_DOCS}start.html`,
supportedNlpModels: `${MACHINE_LEARNING_DOCS}ml-nlp-model-ref.html`,

View file

@ -160,7 +160,7 @@ export interface DocLinks {
readonly searchApplicationsTemplates: string;
readonly searchApplicationsSearchApi: string;
readonly searchApplications: string;
readonly searchApplicationsGettingStarted: string;
readonly searchApplicationsSearch: string;
readonly searchTemplates: string;
readonly start: string;
readonly supportedNlpModels: string;

View file

@ -60,7 +60,7 @@ curl --location --request POST '${esUrl}/_application/search_application/${searc
--header 'Content-Type: application/json' \\
--data-raw '${JSON.stringify({ params }, null, 2)}'`;
const apiRequestSnippet = (searchApplicationName: string, params: unknown) => {
const consoleSnippet = (searchApplicationName: string, params: unknown) => {
const body = JSON.stringify({ params }, null, 2);
return `
POST /_application/search_application/${searchApplicationName}/_search
@ -94,13 +94,13 @@ export const SearchApplicationApiIntegrationStage: React.FC = () => {
const params = { query: 'pizza', myCustomParameter: 'example value' };
const Tabs: Record<TabId, Tab> = {
apirequest: {
code: apiRequestSnippet(searchApplicationName, params),
code: consoleSnippet(searchApplicationName, params),
copy: false,
language: 'http',
title: i18n.translate(
'xpack.enterpriseSearch.searchApplications.searchApplication.searchApi.tab.apirequestTitle',
'xpack.enterpriseSearch.searchApplications.searchApplication.searchApi.tab.consoleTitle',
{
defaultMessage: 'API Request',
defaultMessage: 'Console',
}
),
},
@ -147,19 +147,7 @@ export const SearchApplicationApiIntegrationStage: React.FC = () => {
<p>
<FormattedMessage
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.searchApi.step4.clientsDocumenation',
{
defaultMessage: 'programming language clients',
}
)}
</EuiLink>
),
}}
defaultMessage="Simplify your API calls. We recommend using the JavaScript client."
/>
</p>
</EuiText>
@ -244,10 +232,10 @@ export const SearchApplicationApiIntegrationStage: React.FC = () => {
<EuiText>
<FormattedMessage
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."
defaultMessage="To get the most out of the JavaScript client, use the client's example template and follow our {searchapplicationSearchDocLink} on building a search experience."
values={{
searchapplicationGettingStartedDocLink: (
<EuiLink href={docLinks.searchApplicationsGettingStarted}>
searchapplicationSearchDocLink: (
<EuiLink href={docLinks.searchApplicationsSearch}>
{i18n.translate(
'xpack.enterpriseSearch.searchApplications.searchApplication.searchApi.step3.clientDocumenation',
{
@ -272,7 +260,7 @@ export const SearchApplicationApiIntegrationStage: React.FC = () => {
<EuiFlexGroup direction="column" alignItems="flexEnd">
<EuiLink href={consolePreviewLink} target="_blank">
<FormattedMessage
id="xpack.enterpriseSearch.searchApplications.searchApplication.searchApi.step4.apiRequestConsoleButton"
id="xpack.enterpriseSearch.searchApplications.searchApplication.searchApi.step4.consoleButton"
defaultMessage="Try in console"
/>
</EuiLink>

View file

@ -115,7 +115,7 @@ class DocLinks {
public queryDsl: string;
public rrf: string;
public searchApplications: string;
public searchApplicationsGettingStarted: string;
public searchApplicationsSearch: string;
public searchApplicationsTemplates: string;
public searchApplicationsSearchApi: string;
public searchTemplates: string;
@ -273,7 +273,7 @@ class DocLinks {
this.searchUIElasticsearch = '';
this.searchApplicationsTemplates = '';
this.searchApplications = '';
this.searchApplicationsGettingStarted = '';
this.searchApplicationsSearch = '';
this.searchApplicationsSearchApi = '';
this.searchTemplates = '';
this.start = '';
@ -431,8 +431,7 @@ class DocLinks {
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.searchApplicationsSearch = docLinks.links.enterpriseSearch.searchApplicationsSearch;
this.searchTemplates = docLinks.links.enterpriseSearch.searchTemplates;
this.start = docLinks.links.enterpriseSearch.start;
this.supportedNlpModels = docLinks.links.enterpriseSearch.supportedNlpModels;