[App Search] Add instructions for PDF Extraction to Crawler Overview (#132179)

This commit is contained in:
Byron Hulcher 2022-05-13 10:48:03 -04:00 committed by GitHub
parent 1cc8c38a98
commit 526b518eba
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 41 additions and 0 deletions

View file

@ -112,6 +112,7 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
synonyms: `${APP_SEARCH_DOCS}synonyms-guide.html`,
webCrawler: `${APP_SEARCH_DOCS}web-crawler.html`,
webCrawlerEventLogs: `${APP_SEARCH_DOCS}view-web-crawler-events-logs.html`,
webCrawlerReference: `${APP_SEARCH_DOCS}web-crawler-reference.html`,
},
enterpriseSearch: {
configuration: `${ENTERPRISE_SEARCH_DOCS}configuration.html`,
@ -526,6 +527,7 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
azureRepo: `${ELASTICSEARCH_DOCS}repository-azure.html`,
gcsRepo: `${ELASTICSEARCH_DOCS}repository-gcs.html`,
hdfsRepo: `${PLUGIN_DOCS}repository-hdfs.html`,
ingestAttachment: `${PLUGIN_DOCS}ingest-attachment.html`,
s3Repo: `${ELASTICSEARCH_DOCS}repository-s3.html`,
snapshotRestoreRepos: `${ELASTICSEARCH_DOCS}snapshots-register-repository.html`,
mapperSize: `${PLUGIN_DOCS}mapper-size-usage.html`,

View file

@ -98,6 +98,7 @@ export interface DocLinks {
readonly synonyms: string;
readonly webCrawler: string;
readonly webCrawlerEventLogs: string;
readonly webCrawlerReference: string;
};
readonly enterpriseSearch: {
readonly configuration: string;
@ -337,6 +338,7 @@ export interface DocLinks {
azureRepo: string;
gcsRepo: string;
hdfsRepo: string;
ingestAttachment: string;
s3Repo: string;
snapshotRestoreRepos: string;
mapperSize: string;

View file

@ -13,6 +13,9 @@ import { EuiFlexGroup, EuiFlexItem, EuiLink, EuiSpacer, EuiText, EuiTitle } from
import { i18n } from '@kbn/i18n';
import { FormattedMessage } from '@kbn/i18n-react';
import { docLinks } from '../../../shared/doc_links';
import { WEB_CRAWLER_DOCS_URL, WEB_CRAWLER_LOG_DOCS_URL } from '../../routes';
import { getEngineBreadcrumbs } from '../engine';
import { AppSearchPageTemplate } from '../layout';
@ -43,6 +46,34 @@ export const CrawlerOverview: React.FC = () => {
pageHeader={{
pageTitle: CRAWLER_TITLE,
rightSideItems: [<ManageCrawlsPopover />, <CrawlerStatusIndicator />],
description: (
<FormattedMessage
id="xpack.enterpriseSearch.appSearch.crawler.pdfExtractionMessage"
defaultMessage="Interested in extracting additional content types? Install the {ingestPluginDocumentationLink} and {deploymentSettingsDocumentationLink}."
values={{
ingestPluginDocumentationLink: (
<EuiLink href={docLinks.pluginsIngestAttachment} target="_blank" external>
{i18n.translate(
'xpack.enterpriseSearch.appSearch.crawler.ingestionPluginDocumentationLink',
{ defaultMessage: 'Elasticsearch ingest attachment plugin' }
)}
</EuiLink>
),
deploymentSettingsDocumentationLink: (
<EuiLink
href={`${docLinks.appSearchWebCrawlerReference}#web-crawler-reference-binary-content-extraction`}
target="_blank"
external
>
{i18n.translate(
'xpack.enterpriseSearch.appSearch.crawler.deploymentSettingsDocumentationLink',
{ defaultMessage: 'review your deployment settings' }
)}
</EuiLink>
),
}}
/>
),
}}
isLoading={dataLoading}
>

View file

@ -30,6 +30,7 @@ class DocLinks {
public appSearchSynonyms: string;
public appSearchWebCrawler: string;
public appSearchWebCrawlerEventLogs: string;
public appSearchWebCrawlerReference: string;
public clientsGoIndex: string;
public clientsGuide: string;
public clientsJavaBasicAuthentication: string;
@ -58,6 +59,7 @@ class DocLinks {
public enterpriseSearchUsersAccess: string;
public kibanaSecurity: string;
public licenseManagement: string;
public pluginsIngestAttachment: string;
public queryDsl: string;
public workplaceSearchApiKeys: string;
public workplaceSearchBox: string;
@ -110,6 +112,7 @@ class DocLinks {
this.appSearchSynonyms = '';
this.appSearchWebCrawler = '';
this.appSearchWebCrawlerEventLogs = '';
this.appSearchWebCrawlerReference = '';
this.clientsGoIndex = '';
this.clientsGuide = '';
this.clientsJavaBasicAuthentication = '';
@ -138,6 +141,7 @@ class DocLinks {
this.enterpriseSearchUsersAccess = '';
this.kibanaSecurity = '';
this.licenseManagement = '';
this.pluginsIngestAttachment = '';
this.queryDsl = '';
this.workplaceSearchApiKeys = '';
this.workplaceSearchBox = '';
@ -192,6 +196,7 @@ class DocLinks {
this.appSearchSynonyms = docLinks.links.appSearch.synonyms;
this.appSearchWebCrawler = docLinks.links.appSearch.webCrawler;
this.appSearchWebCrawlerEventLogs = docLinks.links.appSearch.webCrawlerEventLogs;
this.appSearchWebCrawlerReference = docLinks.links.appSearch.webCrawlerReference;
this.clientsGoIndex = docLinks.links.clients.goIndex;
this.clientsGuide = docLinks.links.clients.guide;
this.clientsJavaBasicAuthentication = docLinks.links.clients.javaBasicAuthentication;
@ -220,6 +225,7 @@ class DocLinks {
this.enterpriseSearchUsersAccess = docLinks.links.enterpriseSearch.usersAccess;
this.kibanaSecurity = docLinks.links.kibana.xpackSecurity;
this.licenseManagement = docLinks.links.enterpriseSearch.licenseManagement;
this.pluginsIngestAttachment = docLinks.links.plugins.ingestAttachment;
this.queryDsl = docLinks.links.query.queryDsl;
this.workplaceSearchApiKeys = docLinks.links.workplaceSearch.apiKeys;
this.workplaceSearchBox = docLinks.links.workplaceSearch.box;