github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 09:19:04 -04:00
Code Issues Projects Releases Packages Wiki Activity

Fix broken documentation links in the App Search plugin (#198572)

Browse source
This commit is contained in:
Aurélien FOUCRET 2024-10-31 19:53:14 +01:00 • committed by GitHub
parent 7b05079d94
commit 80d5121b80
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
27 changed files with 66 additions and 81 deletions
Download patch file Download diff file Expand all files Collapse all files

4
x-pack/plugins/enterprise_search/public/applications/app_search/components/api_logs/components/empty_state.tsx
View file

@ -11,7 +11,7 @@ import { EuiButton, EuiEmptyPrompt } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { API_DOCS_URL } from '../../../routes';
import { docLinks } from '../../../../shared/doc_links';
export const EmptyState: React.FC = () => (
<EuiEmptyPrompt
@ -31,7 +31,7 @@ export const EmptyState: React.FC = () => (
</p>
}
actions={
<EuiButton size="s" target="_blank" iconType="popout" href={API_DOCS_URL}>
<EuiButton size="s" target="_blank" iconType="popout" href={docLinks.appSearchApis}>
{i18n.translate('xpack.enterpriseSearch.appSearch.engine.apiLogs.empty.buttonLabel', {
defaultMessage: 'View the API reference',
})}

4
x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/components/crawl_rules_table.tsx
View file

@ -23,11 +23,11 @@ import {
import { i18n } from '@kbn/i18n';
import { FormattedMessage } from '@kbn/i18n-react';
import { docLinks } from '../../../../shared/doc_links';
import { clearFlashMessages, flashSuccessToast } from '../../../../shared/flash_messages';
import { GenericEndpointInlineEditableTable } from '../../../../shared/tables/generic_endpoint_inline_editable_table';
import { InlineEditableTableColumn } from '../../../../shared/tables/inline_editable_table/types';
import { ItemWithAnID } from '../../../../shared/tables/types';
import { CRAWL_RULES_DOCS_URL } from '../../../routes';
import { CrawlerSingleDomainLogic } from '../crawler_single_domain_logic';
import {
CrawlerPolicies,
@ -53,7 +53,7 @@ const DEFAULT_DESCRIPTION = (
defaultMessage="Create a crawl rule to include or exclude pages whose URL matches the rule. Rules run in sequential order, and each URL is evaluated according to the first match. {link}"
values={{
link: (
<EuiLink href={CRAWL_RULES_DOCS_URL} target="_blank" external>
<EuiLink href={docLinks.appSearchCrawlRules} target="_blank" external>
{i18n.translate(
'xpack.enterpriseSearch.appSearch.crawler.crawlRulesTable.descriptionLinkText',
{ defaultMessage: 'Learn more about crawl rules' }

4
x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/components/deduplication_panel/deduplication_panel.tsx
View file

@ -27,7 +27,7 @@ import { EuiSelectableLIOption } from '@elastic/eui/src/components/selectable/se
import { i18n } from '@kbn/i18n';
import { FormattedMessage } from '@kbn/i18n-react';
import { DUPLICATE_DOCS_URL } from '../../../../routes';
import { docLinks } from '../../../../../shared/doc_links';
import { DataPanel } from '../../../data_panel';
import { CrawlerSingleDomainLogic } from '../../crawler_single_domain_logic';
@ -84,7 +84,7 @@ export const DeduplicationPanel: React.FC = () => {
documents on this domain. {documentationLink}."
values={{
documentationLink: (
<EuiLink href={DUPLICATE_DOCS_URL} target="_blank" external>
<EuiLink href={docLinks.appSearchDuplicateDocuments} target="_blank" external>
{i18n.translate(
'xpack.enterpriseSearch.appSearch.crawler.deduplicationPanel.learnMoreMessage',
{

4
x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/components/entry_points_table.tsx
View file

@ -14,10 +14,10 @@ import { EuiFieldText, EuiLink, EuiSpacer, EuiText, EuiTitle } from '@elastic/eu
import { i18n } from '@kbn/i18n';
import { FormattedMessage } from '@kbn/i18n-react';
import { docLinks } from '../../../../shared/doc_links';
import { GenericEndpointInlineEditableTable } from '../../../../shared/tables/generic_endpoint_inline_editable_table';
import { InlineEditableTableColumn } from '../../../../shared/tables/inline_editable_table/types';
import { ItemWithAnID } from '../../../../shared/tables/types';
import { ENTRY_POINTS_DOCS_URL } from '../../../routes';
import { CrawlerDomain, EntryPoint } from '../types';
import { EntryPointsTableLogic } from './entry_points_table_logic';
@ -80,7 +80,7 @@ export const EntryPointsTable: React.FC<EntryPointsTableProps> = ({
defaultMessage:
'Include the most important URLs for your website here. Entry point URLs will be the first pages to be indexed and processed for links to other pages.',
})}{' '}
<EuiLink href={ENTRY_POINTS_DOCS_URL} target="_blank" external>
<EuiLink href={docLinks.appSearchEntryPoints} target="_blank" external>
{i18n.translate(
'xpack.enterpriseSearch.appSearch.crawler.entryPointsTable.learnMoreLinkText',
{ defaultMessage: 'Learn more about entry points.' }

4
x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/components/manage_crawls_popover/automatic_crawl_scheduler.tsx
View file

@ -36,8 +36,8 @@ import {
MONTHS_UNIT_LABEL,
WEEKS_UNIT_LABEL,
} from '../../../../../shared/constants/units';
import { docLinks } from '../../../../../shared/doc_links';
import { WEB_CRAWLER_DOCS_URL } from '../../../../routes';
import { CrawlUnits } from '../../types';
import { AutomaticCrawlSchedulerLogic } from './automatic_crawl_scheduler_logic';
@ -81,7 +81,7 @@ export const AutomaticCrawlScheduler: React.FC = () => {
defaultMessage="Don't worry about it, we'll start a crawl for you. {readMoreMessage}."
values={{
readMoreMessage: (
<EuiLink href={WEB_CRAWLER_DOCS_URL} target="_blank">
<EuiLink href={docLinks.appSearchWebCrawler} target="_blank">
{i18n.translate(
'xpack.enterpriseSearch.appSearch.crawler.automaticCrawlSchedule.readMoreLink',
{

6
x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/crawler_overview.tsx
View file

@ -13,7 +13,7 @@ import { EuiFlexGroup, EuiFlexItem, EuiLink, EuiSpacer, EuiText, EuiTitle } from
import { i18n } from '@kbn/i18n';
import { WEB_CRAWLER_DOCS_URL, WEB_CRAWLER_LOG_DOCS_URL } from '../../routes';
import { docLinks } from '../../../shared/doc_links';
import { getEngineBreadcrumbs } from '../engine';
import { AppSearchPageTemplate } from '../layout';
@ -82,7 +82,7 @@ export const CrawlerOverview: React.FC = () => {
defaultMessage:
"Easily index your website's content. To get started, enter your domain name, provide optional entry points and crawl rules, and we will handle the rest.",
})}{' '}
<EuiLink external target="_blank" href={WEB_CRAWLER_DOCS_URL}>
<EuiLink external target="_blank" href={docLinks.appSearchWebCrawler}>
{i18n.translate(
'xpack.enterpriseSearch.appSearch.crawler.empty.crawlerDocumentationLinkDescription',
{
@ -125,7 +125,7 @@ export const CrawlerOverview: React.FC = () => {
defaultMessage:
"Recent crawl requests are logged here. Using the request ID of each crawl, you can track progress and examine crawl events in Kibana's Discover or Logs user interfaces.",
})}{' '}
<EuiLink href={WEB_CRAWLER_LOG_DOCS_URL} target="_blank" external>
<EuiLink href={docLinks.appSearchWebCrawlerEventLogs} target="_blank" external>
{i18n.translate(
'xpack.enterpriseSearch.appSearch.crawler.configurationDocumentationLinkDescription',
{

4
x-pack/plugins/enterprise_search/public/applications/app_search/components/credentials/constants.ts
View file

@ -7,8 +7,6 @@
import { i18n } from '@kbn/i18n';
import { AUTHENTICATION_DOCS_URL } from '../../routes';
export const CREDENTIALS_TITLE = i18n.translate(
'xpack.enterpriseSearch.appSearch.credentials.title',
{ defaultMessage: 'Credentials' }
@ -108,5 +106,3 @@ export const TOKEN_TYPE_INFO = [
];
export const FLYOUT_ARIA_LABEL_ID = 'credentialsFlyoutTitle';
export const DOCS_HREF = AUTHENTICATION_DOCS_URL;

6
x-pack/plugins/enterprise_search/public/applications/app_search/components/credentials/credentials_flyout/form_components/key_type.tsx
View file

@ -12,8 +12,10 @@ import { useValues, useActions } from 'kea';
import { EuiFormRow, EuiSelect, EuiText, EuiLink } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { docLinks } from '../../../../../shared/doc_links';
import { AppLogic } from '../../../../app_logic';
import { TOKEN_TYPE_DESCRIPTION, TOKEN_TYPE_INFO, DOCS_HREF } from '../../constants';
import { TOKEN_TYPE_DESCRIPTION, TOKEN_TYPE_INFO } from '../../constants';
import { CredentialsLogic } from '../../credentials_logic';
export const FormKeyType: React.FC = () => {
@ -36,7 +38,7 @@ export const FormKeyType: React.FC = () => {
<EuiText size="xs">
<p>
<strong>{tokenDescription}</strong>{' '}
<EuiLink href={DOCS_HREF}>
<EuiLink target="_blank" href={docLinks.appSearchAuthentication}>
{i18n.translate('xpack.enterpriseSearch.appSearch.credentials.documentationLink1', {
defaultMessage: 'Visit the documentation',
})}

4
x-pack/plugins/enterprise_search/public/applications/app_search/components/credentials/credentials_list/credentials_list.tsx
View file

@ -19,9 +19,9 @@ import {
import { i18n } from '@kbn/i18n';
import { EDIT_BUTTON_LABEL, DELETE_BUTTON_LABEL } from '../../../../shared/constants';
import { docLinks } from '../../../../shared/doc_links';
import { HiddenText } from '../../../../shared/hidden_text';
import { convertMetaToPagination, handlePageChange } from '../../../../shared/table_pagination';
import { API_KEYS_DOCS_URL } from '../../../routes';
import { TOKEN_TYPE_DISPLAY_NAMES } from '../constants';
import { CredentialsLogic } from '../credentials_logic';
import { ApiToken } from '../types';
@ -141,7 +141,7 @@ export const CredentialsList: React.FC = () => {
defaultMessage: 'Allow applications to access Elastic App Search on your behalf.',
})}
actions={
<EuiButton size="s" target="_blank" iconType="popout" href={API_KEYS_DOCS_URL}>
<EuiButton size="s" target="_blank" iconType="popout" href={docLinks.appSearchApiKeys}>
{i18n.translate('xpack.enterpriseSearch.appSearch.credentials.empty.buttonLabel', {
defaultMessage: 'Learn about API keys',
})}

4
x-pack/plugins/enterprise_search/public/applications/app_search/components/curations/components/empty_state.tsx
View file

@ -10,7 +10,7 @@ import React from 'react';
import { EuiButton, EuiEmptyPrompt } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { CURATIONS_DOCS_URL } from '../../../routes';
import { docLinks } from '../../../../shared/doc_links';
export const EmptyState: React.FC = () => (
<EuiEmptyPrompt
@ -33,7 +33,7 @@ export const EmptyState: React.FC = () => (
</p>
}
actions={
<EuiButton size="s" target="_blank" iconType="popout" href={CURATIONS_DOCS_URL}>
<EuiButton size="s" target="_blank" iconType="popout" href={docLinks.appSearchCurations}>
{i18n.translate('xpack.enterpriseSearch.appSearch.engine.curations.empty.buttonLabel', {
defaultMessage: 'Read the curations guide',
})}

6
x-pack/plugins/enterprise_search/public/applications/app_search/components/document_creation/creation_mode_components/api_code_example.tsx
View file

@ -30,8 +30,8 @@ import { FormattedMessage } from '@kbn/i18n-react';
import { DocumentCreationLogic } from '..';
import { CANCEL_BUTTON_LABEL } from '../../../../shared/constants';
import { docLinks } from '../../../../shared/doc_links';
import { getEnterpriseSearchUrl } from '../../../../shared/enterprise_search_url';
import { API_CLIENTS_DOCS_URL, INDEXING_DOCS_URL } from '../../../routes';
import { EngineLogic } from '../../engine';
import { EngineDetails } from '../../engine/types';
@ -74,12 +74,12 @@ export const FlyoutBody: React.FC = () => {
defaultMessage="The {documentsApiLink} can be used to add new documents to your engine, update documents, retrieve documents by id, and delete documents. There are a variety of {clientLibrariesLink} to help you get started."
values={{
documentsApiLink: (
<EuiLink target="_blank" href={INDEXING_DOCS_URL}>
<EuiLink target="_blank" href={docLinks.appSearchIndexingDocs}>
documents API
</EuiLink>
),
clientLibrariesLink: (
<EuiLink target="_blank" href={API_CLIENTS_DOCS_URL}>
<EuiLink target="_blank" href={docLinks.appSearchApiClients}>
client libraries
</EuiLink>
),

5
x-pack/plugins/enterprise_search/public/applications/app_search/components/document_creation/document_creation_buttons.tsx
View file

@ -26,9 +26,10 @@ import {
} from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { docLinks } from '../../../shared/doc_links';
import { parseQueryParams } from '../../../shared/query_params';
import { EuiCardTo } from '../../../shared/react_router_helpers';
import { INDEXING_DOCS_URL, ENGINE_CRAWLER_PATH } from '../../routes';
import { ENGINE_CRAWLER_PATH } from '../../routes';
import { generateEnginePath } from '../engine';
import illustration from './illustration.svg';
@ -106,7 +107,7 @@ export const DocumentCreationButtons: React.FC<Props> = ({
)}
</span>
</EuiTitle>{' '}
<EuiLink href={INDEXING_DOCS_URL} target="_blank">
<EuiLink href={docLinks.appSearchIndexingDocs} target="_blank">
{i18n.translate(
'xpack.enterpriseSearch.appSearch.documentCreation.buttons.emptyStateFooterLink',
{ defaultMessage: 'Read documentation' }

4
x-pack/plugins/enterprise_search/public/applications/app_search/components/documents/components/empty_state.tsx
View file

@ -10,7 +10,7 @@ import React from 'react';
import { EuiButton, EuiEmptyPrompt } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { INDEXING_DOCS_URL } from '../../../routes';
import { docLinks } from '../../../../shared/doc_links';
export const EmptyState = () => (
<EuiEmptyPrompt
@ -32,7 +32,7 @@ export const EmptyState = () => (
</p>
}
actions={
<EuiButton size="s" target="_blank" iconType="popout" href={INDEXING_DOCS_URL}>
<EuiButton size="s" target="_blank" iconType="popout" href={docLinks.appSearchIndexingDocs}>
{i18n.translate('xpack.enterpriseSearch.appSearch.engine.documents.empty.buttonLabel', {
defaultMessage: 'Read the documents guide',
})}

4
x-pack/plugins/enterprise_search/public/applications/app_search/components/engine_overview/engine_overview_empty.tsx
View file

@ -12,8 +12,8 @@ import { useValues } from 'kea';
import { EuiButton, EuiEmptyPrompt, EuiImage, EuiSpacer } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { docLinks } from '../../../shared/doc_links';
import { EuiButtonTo } from '../../../shared/react_router_helpers';
import { DOCS_URL } from '../../routes';
import { DocumentCreationButtons, DocumentCreationFlyout } from '../document_creation';
import illustration from '../document_creation/illustration.svg';
@ -85,7 +85,7 @@ export const EmptyEngineOverview: React.FC = () => {
{ defaultMessage: 'Engine setup' }
),
rightSideItems: [
<EuiButton href={DOCS_URL} target="_blank" iconType="popout">
<EuiButton href={docLinks.appSearchGuide} target="_blank" iconType="popout">
{i18n.translate(
'xpack.enterpriseSearch.appSearch.engine.overview.empty.headingAction',
{ defaultMessage: 'View documentation' }

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

@ -10,7 +10,7 @@ import React from 'react';
import { EuiEmptyPrompt, EuiButton } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { META_ENGINES_DOCS_URL } from '../../../routes';
import { docLinks } from '../../../../shared/doc_links';
export const EmptyMetaEnginesState: React.FC = () => (
<EuiEmptyPrompt
@ -34,7 +34,7 @@ export const EmptyMetaEnginesState: React.FC = () => (
</p>
}
actions={
<EuiButton size="s" target="_blank" iconType="popout" href={META_ENGINES_DOCS_URL}>
<EuiButton size="s" target="_blank" iconType="popout" href={docLinks.appSearchMetaEngines}>
{i18n.translate(
'xpack.enterpriseSearch.appSearch.engines.metaEngines.emptyPromptButtonLabel',
{ defaultMessage: 'Learn more about meta engines' }

4
x-pack/plugins/enterprise_search/public/applications/app_search/components/meta_engine_creation/constants.tsx
View file

@ -11,7 +11,7 @@ import { EuiLink } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { FormattedMessage } from '@kbn/i18n-react';
import { META_ENGINES_DOCS_URL } from '../../routes';
import { docLinks } from '../../../shared/doc_links';
export const DEFAULT_LANGUAGE = 'Universal';
@ -57,7 +57,7 @@ export const META_ENGINE_CREATION_FORM_DOCUMENTATION_DESCRIPTION = (
defaultMessage="{documentationLink} for information about how to get started."
values={{
documentationLink: (
<EuiLink href={META_ENGINES_DOCS_URL} target="_blank">
<EuiLink href={docLinks.appSearchMetaEngines} target="_blank">
{META_ENGINE_CREATION_FORM_DOCUMENTATION_LINK}
</EuiLink>
),

4
x-pack/plugins/enterprise_search/public/applications/app_search/components/relevance_tuning/components/empty_state.tsx
View file

@ -10,7 +10,7 @@ import React from 'react';
import { EuiButton, EuiEmptyPrompt } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { RELEVANCE_DOCS_URL } from '../../../routes';
import { docLinks } from '../../../../shared/doc_links';
export const EmptyState: React.FC = () => (
<EuiEmptyPrompt
@ -30,7 +30,7 @@ export const EmptyState: React.FC = () => (
}
)}
actions={
<EuiButton size="s" target="_blank" iconType="popout" href={RELEVANCE_DOCS_URL}>
<EuiButton size="s" target="_blank" iconType="popout" href={docLinks.appSearchRelevance}>
{i18n.translate(
'xpack.enterpriseSearch.appSearch.engine.relevanceTuning.empty.buttonLabel',
{ defaultMessage: 'Read the relevance tuning guide' }

8
x-pack/plugins/enterprise_search/public/applications/app_search/components/relevance_tuning/components/precision_slider/precision_slider.tsx
View file

@ -21,7 +21,7 @@ import {
} from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { PRECISION_DOCS_URL } from '../../../../routes';
import { docLinks } from '../../../../../shared/doc_links';
import { RelevanceTuningLogic } from '../../relevance_tuning_logic';
import { STEP_DESCRIPTIONS } from './constants';
@ -57,7 +57,11 @@ export const PrecisionSlider: React.FC = () => {
defaultMessage: 'Fine tune the precision vs. recall settings on your engine.',
}
)}{' '}
<EuiLink data-test-subj="documentationLink" href={PRECISION_DOCS_URL} target="_blank">
<EuiLink
data-test-subj="documentationLink"
href={docLinks.appSearchPrecision}
target="_blank"
>
{i18n.translate(
'xpack.enterpriseSearch.appSearch.engine.relevanceTuning.precisionSlider.learnMore.link',
{

5
x-pack/plugins/enterprise_search/public/applications/app_search/components/relevance_tuning/relevance_tuning_callouts.tsx
View file

@ -13,8 +13,9 @@ import { EuiCallOut, EuiLink } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { FormattedMessage } from '@kbn/i18n-react';
import { docLinks } from '../../../shared/doc_links';
import { EuiLinkTo } from '../../../shared/react_router_helpers';
import { META_ENGINES_DOCS_URL, ENGINE_SCHEMA_PATH } from '../../routes';
import { ENGINE_SCHEMA_PATH } from '../../routes';
import { EngineLogic, generateEnginePath } from '../engine';
import { RelevanceTuningLogic } from '.';
@ -98,7 +99,7 @@ export const RelevanceTuningCallouts: React.FC = () => {
values={{
schemaFieldsWithConflictsCount,
link: (
<EuiLink href={META_ENGINES_DOCS_URL} target="_blank">
<EuiLink href={docLinks.appSearchMetaEngines} target="_blank">
{i18n.translate(
'xpack.enterpriseSearch.appSearch.engine.relevanceTuning.whatsThisLinkLabel',
{

4
x-pack/plugins/enterprise_search/public/applications/app_search/components/result_settings/components/empty_state.tsx
View file

@ -10,7 +10,7 @@ import React from 'react';
import { EuiButton, EuiEmptyPrompt } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { RESULT_SETTINGS_DOCS_URL } from '../../../routes';
import { docLinks } from '../../../../shared/doc_links';
export const EmptyState: React.FC = () => (
<EuiEmptyPrompt
@ -30,7 +30,7 @@ export const EmptyState: React.FC = () => (
}
)}
actions={
<EuiButton size="s" target="_blank" iconType="popout" href={RESULT_SETTINGS_DOCS_URL}>
<EuiButton size="s" target="_blank" iconType="popout" href={docLinks.appSearchResultSettings}>
{i18n.translate(
'xpack.enterpriseSearch.appSearch.engine.resultSettings.empty.buttonLabel',
{ defaultMessage: 'Read the result settings guide' }

6
x-pack/plugins/enterprise_search/public/applications/app_search/components/role_mappings/role_mappings.tsx
View file

@ -12,6 +12,7 @@ import { useActions, useValues } from 'kea';
import { EuiSpacer } from '@elastic/eui';
import { APP_SEARCH_PLUGIN } from '../../../../../common/constants';
import { docLinks } from '../../../shared/doc_links';
import {
RoleMappingsTable,
RoleMappingsHeading,
@ -22,7 +23,6 @@ import {
} from '../../../shared/role_mapping';
import { ROLE_MAPPINGS_TITLE } from '../../../shared/role_mapping/constants';
import { SECURITY_DOCS_URL } from '../../routes';
import { AppSearchPageTemplate } from '../layout';
import { ROLE_MAPPINGS_ENGINE_ACCESS_HEADING } from './constants';
@ -57,7 +57,7 @@ export const RoleMappings: React.FC = () => {
const rolesEmptyState = (
<RolesEmptyPrompt
productName={APP_SEARCH_PLUGIN.NAME}
docsLink={SECURITY_DOCS_URL}
docsLink={docLinks.appSearchSecurity}
onEnable={enableRoleBasedAccess}
/>
);
@ -66,7 +66,7 @@ export const RoleMappings: React.FC = () => {
<section>
<RoleMappingsHeading
productName={APP_SEARCH_PLUGIN.NAME}
docsLink={SECURITY_DOCS_URL}
docsLink={docLinks.appSearchSecurity}
onClick={() => initializeRoleMapping()}
/>
<RoleMappingsTable

9
x-pack/plugins/enterprise_search/public/applications/app_search/components/schema/components/empty_state.tsx
View file

@ -12,8 +12,8 @@ import { useValues, useActions } from 'kea';
import { EuiEmptyPrompt, EuiButton } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { docLinks } from '../../../../shared/doc_links';
import { SchemaAddFieldModal } from '../../../../shared/schema';
import { INDEXING_SCHEMA_DOCS_URL } from '../../../routes';
import { SchemaLogic } from '../schema_logic';
export const EmptyState: React.FC = () => {
@ -40,7 +40,12 @@ export const EmptyState: React.FC = () => {
</p>
}
actions={
<EuiButton size="s" target="_blank" iconType="popout" href={INDEXING_SCHEMA_DOCS_URL}>
<EuiButton
size="s"
target="_blank"
iconType="popout"
href={docLinks.appSearchIndexingDocsSchema}
>
{i18n.translate('xpack.enterpriseSearch.appSearch.engine.schema.empty.buttonLabel', {
defaultMessage: 'Read the indexing schema guide',
})}

4
x-pack/plugins/enterprise_search/public/applications/app_search/components/search_ui/components/empty_state.tsx
View file

@ -10,7 +10,7 @@ import React from 'react';
import { EuiButton, EuiEmptyPrompt } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { SEARCH_UI_DOCS_URL } from '../../../routes';
import { docLinks } from '../../../../shared/doc_links';
export const EmptyState: React.FC = () => (
<EuiEmptyPrompt
@ -31,7 +31,7 @@ export const EmptyState: React.FC = () => (
</p>
}
actions={
<EuiButton size="s" target="_blank" iconType="popout" href={SEARCH_UI_DOCS_URL}>
<EuiButton size="s" target="_blank" iconType="popout" href={docLinks.appSearchSearchUI}>
{i18n.translate('xpack.enterpriseSearch.appSearch.engine.searchUI.empty.buttonLabel', {
defaultMessage: 'Read the Search UI guide',
})}

4
x-pack/plugins/enterprise_search/public/applications/app_search/components/search_ui/search_ui.tsx
View file

@ -12,7 +12,7 @@ import { useActions, useValues } from 'kea';
import { EuiText, EuiFlexItem, EuiFlexGroup, EuiSpacer, EuiLink } from '@elastic/eui';
import { FormattedMessage } from '@kbn/i18n-react';
import { SEARCH_UI_DOCS_URL } from '../../routes';
import { docLinks } from '../../../shared/doc_links';
import { EngineLogic, getEngineBreadcrumbs } from '../engine';
import { AppSearchPageTemplate } from '../layout';
@ -63,7 +63,7 @@ export const SearchUI: React.FC = () => {
defaultMessage="Use the fields below to generate a sample search experience built with Search UI. Use the sample to preview search results, or build upon it to create your own custom search experience. {link}."
values={{
link: (
<EuiLink target="_blank" href={SEARCH_UI_DOCS_URL}>
<EuiLink target="_blank" href={docLinks.appSearchSearchUI}>
<FormattedMessage
id="xpack.enterpriseSearch.appSearch.engine.searchUI.guideLinkText"
defaultMessage="Learn more about Search UI"

4
x-pack/plugins/enterprise_search/public/applications/app_search/components/settings/log_retention/log_retention_panel.tsx
View file

@ -20,7 +20,7 @@ import {
} from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { LOG_SETTINGS_DOCS_URL } from '../../../routes';
import { docLinks } from '../../../../shared/doc_links';
import { LogRetentionLogic, LogRetentionOptions, LogRetentionMessage } from '../../log_retention';
@ -163,7 +163,7 @@ export const LogRetentionPanel: React.FC = () => {
defaultMessage: 'Log retention is determined by the ILM policies for your deployment.',
})}
<br />
<EuiLink href={LOG_SETTINGS_DOCS_URL} target="_blank">
<EuiLink href={docLinks.appSearchLogSettings} target="_blank">
{i18n.translate('xpack.enterpriseSearch.appSearch.settings.logRetention.learnMore', {
defaultMessage: 'Learn more about log retention for Enterprise Search.',
})}

4
x-pack/plugins/enterprise_search/public/applications/app_search/components/synonyms/components/empty_state.tsx
View file

@ -10,7 +10,7 @@ import React from 'react';
import { EuiEmptyPrompt, EuiButton } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { SYNONYMS_DOCS_URL } from '../../../routes';
import { docLinks } from '../../../../shared/doc_links';
import { SynonymModal, SynonymIcon } from '.';
@ -35,7 +35,7 @@ export const EmptyState: React.FC = () => {
</p>
}
actions={
<EuiButton size="s" target="_blank" iconType="popout" href={SYNONYMS_DOCS_URL}>
<EuiButton size="s" target="_blank" iconType="popout" href={docLinks.appSearchSynonyms}>
{i18n.translate('xpack.enterpriseSearch.appSearch.engine.synonyms.empty.buttonLabel', {
defaultMessage: 'Read the synonyms guide',
})}

24
x-pack/plugins/enterprise_search/public/applications/app_search/routes.ts
View file

@ -5,30 +5,6 @@
* 2.0.
*/
import { docLinks } from '../shared/doc_links';
export const API_DOCS_URL = docLinks.appSearchApis;
export const API_CLIENTS_DOCS_URL = docLinks.appSearchApiClients;
export const API_KEYS_DOCS_URL = docLinks.appSearchApiKeys;
export const AUTHENTICATION_DOCS_URL = docLinks.appSearchAuthentication;
export const CRAWL_RULES_DOCS_URL = docLinks.appSearchCrawlRules;
export const CURATIONS_DOCS_URL = docLinks.appSearchCurations;
export const DOCS_URL = docLinks.appSearchGuide;
export const DUPLICATE_DOCS_URL = docLinks.appSearchDuplicateDocuments;
export const ENTRY_POINTS_DOCS_URL = docLinks.appSearchEntryPoints;
export const INDEXING_DOCS_URL = docLinks.appSearchIndexingDocs;
export const INDEXING_SCHEMA_DOCS_URL = docLinks.appSearchIndexingDocsSchema;
export const LOG_SETTINGS_DOCS_URL = docLinks.appSearchLogSettings;
export const META_ENGINES_DOCS_URL = docLinks.appSearchMetaEngines;
export const PRECISION_DOCS_URL = docLinks.appSearchPrecision;
export const RELEVANCE_DOCS_URL = docLinks.appSearchRelevance;
export const RESULT_SETTINGS_DOCS_URL = docLinks.appSearchResultSettings;
export const SEARCH_UI_DOCS_URL = docLinks.appSearchSearchUI;
export const SECURITY_DOCS_URL = docLinks.appSearchSecurity;
export const SYNONYMS_DOCS_URL = docLinks.appSearchSynonyms;
export const WEB_CRAWLER_DOCS_URL = docLinks.appSearchWebCrawler;
export const WEB_CRAWLER_LOG_DOCS_URL = docLinks.appSearchWebCrawlerEventLogs;
export const ROOT_PATH = '/';
export const SETUP_GUIDE_PATH = '/setup_guide';
export const LIBRARY_PATH = '/library';