github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.8] [Search Application] Fix documentation links (#157145) (#157202)

Browse source 
# Backport

This will backport the following commits from `main` to `8.8`:
- [[Search Application] Fix documentation links
(#157145)](https://github.com/elastic/kibana/pull/157145)

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

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

<!--BACKPORT [{"author":{"name":"Yan
Savitski","email":"yan.savitski@elastic.co"},"sourceCommit":{"committedDate":"2023-05-09T17:34:01Z","message":"[Search
Application] Fix documentation links (#157145)\n\nUpdate links to
documentation\r\n- ✔️ Search Application(s) documentation links from
main page\r\n- ✔️ Search Preview page \"Improve your
results\"","sha":"8e0fe1c608d5bfc53481f2a7fe1f4e9e21cfe5b5","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:EnterpriseSearch","v8.8.0","v8.9.0"],"number":157145,"url":"https://github.com/elastic/kibana/pull/157145","mergeCommit":{"message":"[Search
Application] Fix documentation links (#157145)\n\nUpdate links to
documentation\r\n- ✔️ Search Application(s) documentation links from
main page\r\n- ✔️ Search Preview page \"Improve your
results\"","sha":"8e0fe1c608d5bfc53481f2a7fe1f4e9e21cfe5b5"}},"sourceBranch":"main","suggestedTargetBranches":["8.8"],"targetPullRequestStates":[{"branch":"8.8","label":"v8.8.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/157145","number":157145,"mergeCommit":{"message":"[Search
Application] Fix documentation links (#157145)\n\nUpdate links to
documentation\r\n- ✔️ Search Application(s) documentation links from
main page\r\n- ✔️ Search Preview page \"Improve your
results\"","sha":"8e0fe1c608d5bfc53481f2a7fe1f4e9e21cfe5b5"}}]}]
BACKPORT-->

Co-authored-by: Yan Savitski <yan.savitski@elastic.co>
This commit is contained in:
Kibana Machine 2023-05-09 15:23:30 -04:00 • committed by GitHub
parent bea88026b7
commit d2e646db5a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 14 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
packages/kbn-doc-links/src/get_doc_links.ts
View file

@ -155,6 +155,8 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
machineLearningStart: `${ENTERPRISE_SEARCH_DOCS}machine-learning-start.html`,
mailService: `${ENTERPRISE_SEARCH_DOCS}mailer-configuration.html`,
mlDocumentEnrichment: `${ENTERPRISE_SEARCH_DOCS}document-enrichment.html`,
searchApplications: `${ENTERPRISE_SEARCH_DOCS}search-applications.html`,
searchTemplates: `${ELASTICSEARCH_DOCS}search-template.html`,
start: `${ENTERPRISE_SEARCH_DOCS}start.html`,
syncRules: `${ENTERPRISE_SEARCH_DOCS}sync-rules.html`,
troubleshootSetup: `${ENTERPRISE_SEARCH_DOCS}troubleshoot-setup.html`,

2
packages/kbn-doc-links/src/types.ts
View file

@ -140,6 +140,8 @@ export interface DocLinks {
readonly machineLearningStart: string;
readonly mailService: string;
readonly mlDocumentEnrichment: string;
readonly searchApplications: string;
readonly searchTemplates: string;
readonly start: string;
readonly syncRules: string;
readonly troubleshootSetup: string;

2
x-pack/plugins/enterprise_search/public/applications/applications/components/engine/engine_search_preview/engine_search_preview.tsx
View file

@ -349,7 +349,7 @@ export const EngineSearchPreview: React.FC = () => {
<EuiSpacer size="m" />
<Sorting sortableFields={sortableFields} />
<EuiSpacer size="m" />
<EuiLink href={docLinks.enterpriseSearchEngines} target="_blank">
<EuiLink href={docLinks.searchTemplates} target="_blank">
<FormattedMessage
id="xpack.enterpriseSearch.content.engine.searchPreview.improveResultsLink"
defaultMessage="Improve these results"

4
x-pack/plugins/enterprise_search/public/applications/applications/components/engines/create_engine_flyout.tsx
View file

@ -94,14 +94,14 @@ export const CreateEngineFlyout = ({ onClose }: CreateEngineFlyoutProps) => {
values={{
enginesDocsLink: (
<EuiLink
href={docLinks.enterpriseSearchEngines}
href={docLinks.searchApplications}
target="_blank"
data-telemetry-id="entSearchApplications-createEngine-docsLink"
external
>
{i18n.translate(
'xpack.enterpriseSearch.content.engines.createEngine.header.docsLink',
{ defaultMessage: 'Search Application documentation' }
{ defaultMessage: 'Search Applications documentation' }
)}
</EuiLink>
),

2
x-pack/plugins/enterprise_search/public/applications/applications/components/engines/engines_list.tsx
View file

@ -174,7 +174,7 @@ export const EnginesList: React.FC<ListProps> = ({ createEngineFlyoutOpen }) =>
documentationUrl: (
<EuiLink
data-test-subj="engines-documentation-link"
href={docLinks.enterpriseSearchEngines}
href={docLinks.searchApplications}
target="_blank"
data-telemetry-id="entSearchApplications-documentation-viewDocumentaion"
>

6
x-pack/plugins/enterprise_search/public/applications/shared/doc_links/doc_links.ts
View file

@ -98,6 +98,8 @@ class DocLinks {
public queryDsl: string;
public searchUIAppSearch: string;
public searchUIElasticsearch: string;
public searchApplications: string;
public searchTemplates: string;
public start: string;
public syncRules: string;
public workplaceSearchApiKeys: string;
@ -227,6 +229,8 @@ class DocLinks {
this.queryDsl = '';
this.searchUIAppSearch = '';
this.searchUIElasticsearch = '';
this.searchApplications = '';
this.searchTemplates = '';
this.start = '';
this.syncRules = '';
this.workplaceSearchApiKeys = '';
@ -358,6 +362,8 @@ class DocLinks {
this.queryDsl = docLinks.links.query.queryDsl;
this.searchUIAppSearch = docLinks.links.searchUI.appSearch;
this.searchUIElasticsearch = docLinks.links.searchUI.elasticsearch;
this.searchApplications = docLinks.links.enterpriseSearch.searchApplications;
this.searchTemplates = docLinks.links.enterpriseSearch.searchTemplates;
this.start = docLinks.links.enterpriseSearch.start;
this.syncRules = docLinks.links.enterpriseSearch.syncRules;
this.workplaceSearchApiKeys = docLinks.links.workplaceSearch.apiKeys;