Skip to content

Commit

Permalink
Remove links to docs about different auth methods in Enterprise Search (
Browse files Browse the repository at this point in the history 
elastic#120127)

* Remove links to docs about different auth methods in Enterprise Search
  • Loading branch information
@kovyrin @TinLe
kovyrin authored and TinLe committed Dec 22, 2021
1 parent 7d45091 commit 66fe4c8
Show file tree
Hide file tree
Showing 15 changed files with 7 additions and 169 deletions.
4 changes: 0 additions & 4 deletions docs/development/core/public/kibana-plugin-core-public.doclinksstart.links.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,11 @@ readonly links: {
readonly indexingDocumentsSchema: string;
readonly logSettings: string;
readonly metaEngines: string;
readonly nativeAuth: string;
readonly precisionTuning: string;
readonly relevanceTuning: string;
readonly resultSettings: string;
readonly searchUI: string;
readonly security: string;
readonly standardAuth: string;
readonly synonyms: string;
readonly webCrawler: string;
readonly webCrawlerEventLogs: string;
Expand All @@ -105,15 +103,13 @@ readonly links: {
readonly indexingSchedule: string;
readonly jiraCloud: string;
readonly jiraServer: string;
readonly nativeAuth: string;
readonly oneDrive: string;
readonly permissions: string;
readonly salesforce: string;
readonly security: string;
readonly serviceNow: string;
readonly sharePoint: string;
readonly slack: string;
readonly standardAuth: string;
readonly synch: string;
readonly zendesk: string;
};
Expand Down
2 changes: 1 addition & 1 deletion docs/development/core/public/kibana-plugin-core-public.doclinksstart.md
View file

Large diffs are not rendered by default.

8 changes: 0 additions & 8 deletions src/core/public/doc_links/doc_links_service.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,13 +97,11 @@ export class DocLinksService {
indexingDocumentsSchema: `${APP_SEARCH_DOCS}indexing-documents-guide.html#indexing-documents-guide-schema`,
logSettings: `${APP_SEARCH_DOCS}logs.html`,
metaEngines: `${APP_SEARCH_DOCS}meta-engines-guide.html`,
nativeAuth: `${APP_SEARCH_DOCS}security-and-users.html#app-search-self-managed-security-and-user-management-elasticsearch-native-realm`,
precisionTuning: `${APP_SEARCH_DOCS}precision-tuning.html`,
relevanceTuning: `${APP_SEARCH_DOCS}relevance-tuning-guide.html`,
resultSettings: `${APP_SEARCH_DOCS}result-settings-guide.html`,
searchUI: `${APP_SEARCH_DOCS}reference-ui-guide.html`,
security: `${APP_SEARCH_DOCS}security-and-users.html`,
standardAuth: `${APP_SEARCH_DOCS}security-and-users.html#app-search-self-managed-security-and-user-management-standard`,
synonyms: `${APP_SEARCH_DOCS}synonyms-guide.html`,
webCrawler: `${APP_SEARCH_DOCS}web-crawler.html`,
webCrawlerEventLogs: `${APP_SEARCH_DOCS}view-web-crawler-events-logs.html`,
Expand All @@ -130,15 +128,13 @@ export class DocLinksService {
indexingSchedule: `${WORKPLACE_SEARCH_DOCS}workplace-search-customizing-indexing-rules.html#_indexing_schedule`,
jiraCloud: `${WORKPLACE_SEARCH_DOCS}workplace-search-jira-cloud-connector.html`,
jiraServer: `${WORKPLACE_SEARCH_DOCS}workplace-search-jira-server-connector.html`,
nativeAuth: `${WORKPLACE_SEARCH_DOCS}workplace-search-security.html#elasticsearch-native-realm`,
oneDrive: `${WORKPLACE_SEARCH_DOCS}workplace-search-onedrive-connector.html`,
permissions: `${WORKPLACE_SEARCH_DOCS}workplace-search-permissions.html#organizational-sources-private-sources`,
salesforce: `${WORKPLACE_SEARCH_DOCS}workplace-search-salesforce-connector.html`,
security: `${WORKPLACE_SEARCH_DOCS}workplace-search-security.html`,
serviceNow: `${WORKPLACE_SEARCH_DOCS}workplace-search-servicenow-connector.html`,
sharePoint: `${WORKPLACE_SEARCH_DOCS}workplace-search-sharepoint-online-connector.html`,
slack: `${WORKPLACE_SEARCH_DOCS}workplace-search-slack-connector.html`,
standardAuth: `${WORKPLACE_SEARCH_DOCS}workplace-search-security.html#standard`,
synch: `${WORKPLACE_SEARCH_DOCS}workplace-search-customizing-indexing-rules.html`,
zendesk: `${WORKPLACE_SEARCH_DOCS}workplace-search-zendesk-connector.html`,
},
Expand Down Expand Up @@ -659,13 +655,11 @@ export interface DocLinksStart {
readonly indexingDocumentsSchema: string;
readonly logSettings: string;
readonly metaEngines: string;
readonly nativeAuth: string;
readonly precisionTuning: string;
readonly relevanceTuning: string;
readonly resultSettings: string;
readonly searchUI: string;
readonly security: string;
readonly standardAuth: string;
readonly synonyms: string;
readonly webCrawler: string;
readonly webCrawlerEventLogs: string;
Expand All @@ -692,15 +686,13 @@ export interface DocLinksStart {
readonly indexingSchedule: string;
readonly jiraCloud: string;
readonly jiraServer: string;
readonly nativeAuth: string;
readonly oneDrive: string;
readonly permissions: string;
readonly salesforce: string;
readonly security: string;
readonly serviceNow: string;
readonly sharePoint: string;
readonly slack: string;
readonly standardAuth: string;
readonly synch: string;
readonly zendesk: string;
};
Expand Down
4 changes: 0 additions & 4 deletions src/core/public/public.api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -554,13 +554,11 @@ export interface DocLinksStart {
readonly indexingDocumentsSchema: string;
readonly logSettings: string;
readonly metaEngines: string;
readonly nativeAuth: string;
readonly precisionTuning: string;
readonly relevanceTuning: string;
readonly resultSettings: string;
readonly searchUI: string;
readonly security: string;
readonly standardAuth: string;
readonly synonyms: string;
readonly webCrawler: string;
readonly webCrawlerEventLogs: string;
Expand All @@ -587,15 +585,13 @@ export interface DocLinksStart {
readonly indexingSchedule: string;
readonly jiraCloud: string;
readonly jiraServer: string;
readonly nativeAuth: string;
readonly oneDrive: string;
readonly permissions: string;
readonly salesforce: string;
readonly security: string;
readonly serviceNow: string;
readonly sharePoint: string;
readonly slack: string;
readonly standardAuth: string;
readonly synch: string;
readonly zendesk: string;
};
Expand Down
8 changes: 1 addition & 7 deletions ...s/enterprise_search/public/applications/app_search/components/setup_guide/setup_guide.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,11 @@ import { APP_SEARCH_PLUGIN } from '../../../../../common/constants';
import { SetAppSearchChrome as SetPageChrome } from '../../../shared/kibana_chrome';
import { SetupGuideLayout, SETUP_GUIDE_TITLE } from '../../../shared/setup_guide';
import { SendAppSearchTelemetry as SendTelemetry } from '../../../shared/telemetry';
import { NATIVE_AUTH_DOCS_URL, STANDARD_AUTH_DOCS_URL } from '../../routes';

import GettingStarted from './assets/getting_started.png';

export const SetupGuide: React.FC = () => (
<SetupGuideLayout
productName={APP_SEARCH_PLUGIN.NAME}
productEuiIcon="logoAppSearch"
standardAuthLink={STANDARD_AUTH_DOCS_URL}
elasticsearchNativeAuthLink={NATIVE_AUTH_DOCS_URL}
>
<SetupGuideLayout productName={APP_SEARCH_PLUGIN.NAME} productEuiIcon="logoAppSearch">
<SetPageChrome trail={[SETUP_GUIDE_TITLE]} />
<SendTelemetry action="viewed" metric="setup_guide" />

Expand Down
2 changes: 0 additions & 2 deletions x-pack/plugins/enterprise_search/public/applications/app_search/routes.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,11 @@ 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 NATIVE_AUTH_DOCS_URL = docLinks.appSearchNativeAuth;
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 STANDARD_AUTH_DOCS_URL = docLinks.appSearchStandardAuth;
export const SYNONYMS_DOCS_URL = docLinks.appSearchSynonyms;
export const WEB_CRAWLER_DOCS_URL = docLinks.appSearchWebCrawler;
export const WEB_CRAWLER_LOG_DOCS_URL = docLinks.appSearchWebCrawlerEventLogs;
Expand Down
3 changes: 0 additions & 3 deletions ...prise_search/public/applications/enterprise_search/components/setup_guide/setup_guide.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import { i18n } from '@kbn/i18n';
import { FormattedMessage } from '@kbn/i18n-react';

import { ENTERPRISE_SEARCH_PLUGIN } from '../../../../../common/constants';
import { NATIVE_AUTH_DOCS_URL, STANDARD_AUTH_DOCS_URL } from '../../../app_search/routes';
import { SetEnterpriseSearchChrome as SetPageChrome } from '../../../shared/kibana_chrome';
import { SetupGuideLayout, SETUP_GUIDE_TITLE } from '../../../shared/setup_guide';
import { SendEnterpriseSearchTelemetry as SendTelemetry } from '../../../shared/telemetry';
Expand All @@ -23,8 +22,6 @@ export const SetupGuide: React.FC = () => (
<SetupGuideLayout
productName={ENTERPRISE_SEARCH_PLUGIN.NAME}
productEuiIcon="logoEnterpriseSearch"
standardAuthLink={STANDARD_AUTH_DOCS_URL}
elasticsearchNativeAuthLink={NATIVE_AUTH_DOCS_URL}
>
<SetPageChrome trail={[SETUP_GUIDE_TITLE]} />
<SendTelemetry action="viewed" metric="setup_guide" />
Expand Down
12 changes: 0 additions & 12 deletions x-pack/plugins/enterprise_search/public/applications/shared/doc_links/doc_links.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,11 @@ class DocLinks {
public appSearchIndexingDocsSchema: string;
public appSearchLogSettings: string;
public appSearchMetaEngines: string;
public appSearchNativeAuth: string;
public appSearchPrecision: string;
public appSearchRelevance: string;
public appSearchResultSettings: string;
public appSearchSearchUI: string;
public appSearchSecurity: string;
public appSearchStandardAuth: string;
public appSearchSynonyms: string;
public appSearchWebCrawler: string;
public appSearchWebCrawlerEventLogs: string;
Expand All @@ -51,15 +49,13 @@ class DocLinks {
public workplaceSearchIndexingSchedule: string;
public workplaceSearchJiraCloud: string;
public workplaceSearchJiraServer: string;
public workplaceSearchNativeAuth: string;
public workplaceSearchOneDrive: string;
public workplaceSearchPermissions: string;
public workplaceSearchSalesforce: string;
public workplaceSearchSecurity: string;
public workplaceSearchServiceNow: string;
public workplaceSearchSharePoint: string;
public workplaceSearchSlack: string;
public workplaceSearchStandardAuth: string;
public workplaceSearchSynch: string;
public workplaceSearchZendesk: string;

Expand All @@ -77,13 +73,11 @@ class DocLinks {
this.appSearchIndexingDocsSchema = '';
this.appSearchLogSettings = '';
this.appSearchMetaEngines = '';
this.appSearchNativeAuth = '';
this.appSearchPrecision = '';
this.appSearchRelevance = '';
this.appSearchResultSettings = '';
this.appSearchSearchUI = '';
this.appSearchSecurity = '';
this.appSearchStandardAuth = '';
this.appSearchSynonyms = '';
this.appSearchWebCrawler = '';
this.appSearchWebCrawlerEventLogs = '';
Expand All @@ -107,15 +101,13 @@ class DocLinks {
this.workplaceSearchIndexingSchedule = '';
this.workplaceSearchJiraCloud = '';
this.workplaceSearchJiraServer = '';
this.workplaceSearchNativeAuth = '';
this.workplaceSearchOneDrive = '';
this.workplaceSearchPermissions = '';
this.workplaceSearchSalesforce = '';
this.workplaceSearchSecurity = '';
this.workplaceSearchServiceNow = '';
this.workplaceSearchSharePoint = '';
this.workplaceSearchSlack = '';
this.workplaceSearchStandardAuth = '';
this.workplaceSearchSynch = '';
this.workplaceSearchZendesk = '';
}
Expand All @@ -134,13 +126,11 @@ class DocLinks {
this.appSearchIndexingDocsSchema = docLinks.links.appSearch.indexingDocumentsSchema;
this.appSearchLogSettings = docLinks.links.appSearch.logSettings;
this.appSearchMetaEngines = docLinks.links.appSearch.metaEngines;
this.appSearchNativeAuth = docLinks.links.appSearch.nativeAuth;
this.appSearchPrecision = docLinks.links.appSearch.precisionTuning;
this.appSearchRelevance = docLinks.links.appSearch.relevanceTuning;
this.appSearchResultSettings = docLinks.links.appSearch.resultSettings;
this.appSearchSearchUI = docLinks.links.appSearch.searchUI;
this.appSearchSecurity = docLinks.links.appSearch.security;
this.appSearchStandardAuth = docLinks.links.appSearch.standardAuth;
this.appSearchSynonyms = docLinks.links.appSearch.synonyms;
this.appSearchWebCrawler = docLinks.links.appSearch.webCrawler;
this.appSearchWebCrawlerEventLogs = docLinks.links.appSearch.webCrawlerEventLogs;
Expand All @@ -165,15 +155,13 @@ class DocLinks {
this.workplaceSearchIndexingSchedule = docLinks.links.workplaceSearch.indexingSchedule;
this.workplaceSearchJiraCloud = docLinks.links.workplaceSearch.jiraCloud;
this.workplaceSearchJiraServer = docLinks.links.workplaceSearch.jiraServer;
this.workplaceSearchNativeAuth = docLinks.links.workplaceSearch.nativeAuth;
this.workplaceSearchOneDrive = docLinks.links.workplaceSearch.oneDrive;
this.workplaceSearchPermissions = docLinks.links.workplaceSearch.permissions;
this.workplaceSearchSalesforce = docLinks.links.workplaceSearch.salesforce;
this.workplaceSearchSecurity = docLinks.links.workplaceSearch.security;
this.workplaceSearchServiceNow = docLinks.links.workplaceSearch.serviceNow;
this.workplaceSearchSharePoint = docLinks.links.workplaceSearch.sharePoint;
this.workplaceSearchSlack = docLinks.links.workplaceSearch.slack;
this.workplaceSearchStandardAuth = docLinks.links.workplaceSearch.standardAuth;
this.workplaceSearchSynch = docLinks.links.workplaceSearch.synch;
this.workplaceSearchZendesk = docLinks.links.workplaceSearch.zendesk;
}
Expand Down
17 changes: 1 addition & 16 deletions ...ck/plugins/enterprise_search/public/applications/shared/setup_guide/instructions.test.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@ import React from 'react';

import { shallow } from 'enzyme';

import { EuiSteps, EuiLink } from '@elastic/eui';

import { mountWithIntl } from '../../test_helpers';
import { EuiSteps } from '@elastic/eui';

import { SetupInstructions } from './instructions';

Expand All @@ -20,17 +18,4 @@ describe('SetupInstructions', () => {
const wrapper = shallow(<SetupInstructions productName="Workplace Search" />);
expect(wrapper.find(EuiSteps)).toHaveLength(1);
});

it('renders with auth links', () => {
const wrapper = mountWithIntl(
<SetupInstructions
productName="Enterprise Search"
standardAuthLink="http://foo.com"
elasticsearchNativeAuthLink="http://bar.com"
/>
);

expect(wrapper.find(EuiLink).first().prop('href')).toEqual('http://bar.com');
expect(wrapper.find(EuiLink).last().prop('href')).toEqual('http://foo.com');
});
});
Loading

0 comments on commit 66fe4c8

Please sign in to comment.