Add troubleshooting setup guide link to enterprise search instructions page (#127820)

This commit is contained in:
Byron Hulcher 2022-03-15 18:16:50 -04:00 committed by GitHub
parent 21ff56b0f8
commit c9058b850c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 63 additions and 0 deletions

View file

@ -109,6 +109,7 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
configuration: `${ENTERPRISE_SEARCH_DOCS}configuration.html`,
licenseManagement: `${ENTERPRISE_SEARCH_DOCS}license-management.html`,
mailService: `${ENTERPRISE_SEARCH_DOCS}mailer-configuration.html`,
troubleshootSetup: `${ENTERPRISE_SEARCH_DOCS}troubleshoot-setup.html`,
usersAccess: `${ENTERPRISE_SEARCH_DOCS}users-access.html`,
},
workplaceSearch: {

View file

@ -99,6 +99,7 @@ export interface DocLinks {
readonly configuration: string;
readonly licenseManagement: string;
readonly mailService: string;
readonly troubleshootSetup: string;
readonly usersAccess: string;
};
readonly workplaceSearch: {

View file

@ -32,6 +32,7 @@ class DocLinks {
public cloudIndexManagement: string;
public enterpriseSearchConfig: string;
public enterpriseSearchMailService: string;
public enterpriseSearchTroubleshootSetup: string;
public enterpriseSearchUsersAccess: string;
public kibanaSecurity: string;
public licenseManagement: string;
@ -86,6 +87,7 @@ class DocLinks {
this.cloudIndexManagement = '';
this.enterpriseSearchConfig = '';
this.enterpriseSearchMailService = '';
this.enterpriseSearchTroubleshootSetup = '';
this.enterpriseSearchUsersAccess = '';
this.kibanaSecurity = '';
this.licenseManagement = '';
@ -141,6 +143,7 @@ class DocLinks {
this.cloudIndexManagement = docLinks.links.cloud.indexManagement;
this.enterpriseSearchConfig = docLinks.links.enterpriseSearch.configuration;
this.enterpriseSearchMailService = docLinks.links.enterpriseSearch.mailService;
this.enterpriseSearchTroubleshootSetup = docLinks.links.enterpriseSearch.troubleshootSetup;
this.enterpriseSearchUsersAccess = docLinks.links.enterpriseSearch.usersAccess;
this.kibanaSecurity = docLinks.links.kibana.xpackSecurity;
this.licenseManagement = docLinks.links.enterpriseSearch.licenseManagement;

View file

@ -135,6 +135,37 @@ export const CloudSetupInstructions: React.FC<Props> = ({ productName, cloudDepl
</EuiCallOut>
),
},
{
title: i18n.translate('xpack.enterpriseSearch.setupGuide.cloud.step6.title', {
defaultMessage: 'Troubleshooting issues',
}),
children: (
<>
<EuiText>
<p>
<FormattedMessage
id="xpack.enterpriseSearch.setupGuide.cloud.step6.instruction1"
defaultMessage="For help with common setup issues, read our {link} guide."
values={{
link: (
<EuiLink
href={docLinks.enterpriseSearchTroubleshootSetup}
target="_blank"
external
>
{i18n.translate(
'xpack.enterpriseSearch.setupGuide.cloud.step6.instruction1LinkText',
{ defaultMessage: 'Troubleshoot Enterprise Search setup' }
)}
</EuiLink>
),
}}
/>
</p>
</EuiText>
</>
),
},
]}
/>
</EuiPageContent>

View file

@ -14,10 +14,14 @@ import {
EuiCode,
EuiCodeBlock,
EuiAccordion,
EuiLink,
EuiSpacer,
} from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { FormattedMessage } from '@kbn/i18n-react';
import { docLinks } from '../doc_links';
interface Props {
productName: string;
}
@ -94,6 +98,29 @@ export const SetupInstructions: React.FC<Props> = ({ productName }) => (
</p>
</EuiText>
</EuiAccordion>
<EuiSpacer />
<EuiText>
<p>
<FormattedMessage
id="xpack.enterpriseSearch.troubleshooting.setup.description"
defaultMessage="For help with other common setup issues, read our {link} guide."
values={{
link: (
<EuiLink
href={docLinks.enterpriseSearchTroubleshootSetup}
target="_blank"
external
>
{i18n.translate(
'xpack.enterpriseSearch.troubleshooting.setup.documentationLinkLabel',
{ defaultMessage: 'Troubleshoot Enterprise Search setup' }
)}
</EuiLink>
),
}}
/>
</p>
</EuiText>
</>
),
},