Skip to content

Commit 583d2b7

Browse files
author
Byron Hulcher
authored
[Workplace Search] Add documentation links for v8.3.0 connectors (#132547)
1 parent c244883 commit 583d2b7

File tree

4 files changed

+38
-6
lines changed

4 files changed

+38
-6
lines changed

packages/kbn-doc-links/src/get_doc_links.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,9 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
125125
apiKeys: `${WORKPLACE_SEARCH_DOCS}workplace-search-api-authentication.html`,
126126
box: `${WORKPLACE_SEARCH_DOCS}workplace-search-box-connector.html`,
127127
confluenceCloud: `${WORKPLACE_SEARCH_DOCS}workplace-search-confluence-cloud-connector.html`,
128+
confluenceCloudConnectorPackage: `${WORKPLACE_SEARCH_DOCS}confluence-cloud.html`,
128129
confluenceServer: `${WORKPLACE_SEARCH_DOCS}workplace-search-confluence-server-connector.html`,
130+
customConnectorPackage: `${WORKPLACE_SEARCH_DOCS}custom-connector-package.html`,
129131
customSources: `${WORKPLACE_SEARCH_DOCS}workplace-search-custom-api-sources.html`,
130132
customSourcePermissions: `${WORKPLACE_SEARCH_DOCS}workplace-search-custom-api-sources.html#custom-api-source-document-level-access-control`,
131133
documentPermissions: `${WORKPLACE_SEARCH_DOCS}workplace-search-sources-document-permissions.html`,
@@ -139,7 +141,9 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
139141
indexingSchedule: `${WORKPLACE_SEARCH_DOCS}workplace-search-customizing-indexing-rules.html#_indexing_schedule`,
140142
jiraCloud: `${WORKPLACE_SEARCH_DOCS}workplace-search-jira-cloud-connector.html`,
141143
jiraServer: `${WORKPLACE_SEARCH_DOCS}workplace-search-jira-server-connector.html`,
144+
networkDrive: `${WORKPLACE_SEARCH_DOCS}network-drives.html`,
142145
oneDrive: `${WORKPLACE_SEARCH_DOCS}workplace-search-onedrive-connector.html`,
146+
outlook: `${WORKPLACE_SEARCH_DOCS}microsoft-outlook.html`,
143147
permissions: `${WORKPLACE_SEARCH_DOCS}workplace-search-permissions.html#organizational-sources-private-sources`,
144148
salesforce: `${WORKPLACE_SEARCH_DOCS}workplace-search-salesforce-connector.html`,
145149
security: `${WORKPLACE_SEARCH_DOCS}workplace-search-security.html`,
@@ -148,7 +152,9 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
148152
sharePointServer: `${WORKPLACE_SEARCH_DOCS}sharepoint-server.html`,
149153
slack: `${WORKPLACE_SEARCH_DOCS}workplace-search-slack-connector.html`,
150154
synch: `${WORKPLACE_SEARCH_DOCS}workplace-search-customizing-indexing-rules.html`,
155+
teams: `${WORKPLACE_SEARCH_DOCS}microsoft-teams.html`,
151156
zendesk: `${WORKPLACE_SEARCH_DOCS}workplace-search-zendesk-connector.html`,
157+
zoom: `${WORKPLACE_SEARCH_DOCS}zoom.html`,
152158
},
153159
metricbeat: {
154160
base: `${ELASTIC_WEBSITE_URL}guide/en/beats/metricbeat/${DOC_LINK_VERSION}`,

packages/kbn-doc-links/src/types.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,9 @@ export interface DocLinks {
111111
readonly apiKeys: string;
112112
readonly box: string;
113113
readonly confluenceCloud: string;
114+
readonly confluenceCloudConnectorPackage: string;
114115
readonly confluenceServer: string;
116+
readonly customConnectorPackage: string;
115117
readonly customSources: string;
116118
readonly customSourcePermissions: string;
117119
readonly documentPermissions: string;
@@ -125,7 +127,9 @@ export interface DocLinks {
125127
readonly indexingSchedule: string;
126128
readonly jiraCloud: string;
127129
readonly jiraServer: string;
130+
readonly networkDrive: string;
128131
readonly oneDrive: string;
132+
readonly outlook: string;
129133
readonly permissions: string;
130134
readonly salesforce: string;
131135
readonly security: string;
@@ -134,7 +138,9 @@ export interface DocLinks {
134138
readonly sharePointServer: string;
135139
readonly slack: string;
136140
readonly synch: string;
141+
readonly teams: string;
137142
readonly zendesk: string;
143+
readonly zoom: string;
138144
};
139145
readonly heartbeat: {
140146
readonly base: string;

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,9 @@ class DocLinks {
6464
public workplaceSearchApiKeys: string;
6565
public workplaceSearchBox: string;
6666
public workplaceSearchConfluenceCloud: string;
67+
public workplaceSearchConfluenceCloudConnectorPackage: string;
6768
public workplaceSearchConfluenceServer: string;
69+
public workplaceSearchCustomConnectorPackage: string;
6870
public workplaceSearchCustomSources: string;
6971
public workplaceSearchCustomSourcePermissions: string;
7072
public workplaceSearchDocumentPermissions: string;
@@ -78,7 +80,9 @@ class DocLinks {
7880
public workplaceSearchIndexingSchedule: string;
7981
public workplaceSearchJiraCloud: string;
8082
public workplaceSearchJiraServer: string;
83+
public workplaceSearchNetworkDrive: string;
8184
public workplaceSearchOneDrive: string;
85+
public workplaceSearchOutlook: string;
8286
public workplaceSearchPermissions: string;
8387
public workplaceSearchSalesforce: string;
8488
public workplaceSearchSecurity: string;
@@ -87,7 +91,9 @@ class DocLinks {
8791
public workplaceSearchSharePointServer: string;
8892
public workplaceSearchSlack: string;
8993
public workplaceSearchSynch: string;
94+
public workplaceSearchTeams: string;
9095
public workplaceSearchZendesk: string;
96+
public workplaceSearchZoom: string;
9197

9298
constructor() {
9399
this.appSearchApis = '';
@@ -146,7 +152,9 @@ class DocLinks {
146152
this.workplaceSearchApiKeys = '';
147153
this.workplaceSearchBox = '';
148154
this.workplaceSearchConfluenceCloud = '';
155+
this.workplaceSearchConfluenceCloudConnectorPackage = '';
149156
this.workplaceSearchConfluenceServer = '';
157+
this.workplaceSearchCustomConnectorPackage = '';
150158
this.workplaceSearchCustomSources = '';
151159
this.workplaceSearchCustomSourcePermissions = '';
152160
this.workplaceSearchDocumentPermissions = '';
@@ -160,7 +168,9 @@ class DocLinks {
160168
this.workplaceSearchIndexingSchedule = '';
161169
this.workplaceSearchJiraCloud = '';
162170
this.workplaceSearchJiraServer = '';
171+
this.workplaceSearchNetworkDrive = '';
163172
this.workplaceSearchOneDrive = '';
173+
this.workplaceSearchOutlook = '';
164174
this.workplaceSearchPermissions = '';
165175
this.workplaceSearchSalesforce = '';
166176
this.workplaceSearchSecurity = '';
@@ -169,7 +179,9 @@ class DocLinks {
169179
this.workplaceSearchSharePointServer = '';
170180
this.workplaceSearchSlack = '';
171181
this.workplaceSearchSynch = '';
182+
this.workplaceSearchTeams = '';
172183
this.workplaceSearchZendesk = '';
184+
this.workplaceSearchZoom = '';
173185
}
174186

175187
public setDocLinks(docLinks: DocLinksStart): void {
@@ -230,7 +242,11 @@ class DocLinks {
230242
this.workplaceSearchApiKeys = docLinks.links.workplaceSearch.apiKeys;
231243
this.workplaceSearchBox = docLinks.links.workplaceSearch.box;
232244
this.workplaceSearchConfluenceCloud = docLinks.links.workplaceSearch.confluenceCloud;
245+
this.workplaceSearchConfluenceCloudConnectorPackage =
246+
docLinks.links.workplaceSearch.confluenceCloudConnectorPackage;
233247
this.workplaceSearchConfluenceServer = docLinks.links.workplaceSearch.confluenceServer;
248+
this.workplaceSearchCustomConnectorPackage =
249+
docLinks.links.workplaceSearch.customConnectorPackage;
234250
this.workplaceSearchCustomSources = docLinks.links.workplaceSearch.customSources;
235251
this.workplaceSearchCustomSourcePermissions =
236252
docLinks.links.workplaceSearch.customSourcePermissions;
@@ -246,7 +262,9 @@ class DocLinks {
246262
this.workplaceSearchIndexingSchedule = docLinks.links.workplaceSearch.indexingSchedule;
247263
this.workplaceSearchJiraCloud = docLinks.links.workplaceSearch.jiraCloud;
248264
this.workplaceSearchJiraServer = docLinks.links.workplaceSearch.jiraServer;
265+
this.workplaceSearchNetworkDrive = docLinks.links.workplaceSearch.networkDrive;
249266
this.workplaceSearchOneDrive = docLinks.links.workplaceSearch.oneDrive;
267+
this.workplaceSearchOutlook = docLinks.links.workplaceSearch.outlook;
250268
this.workplaceSearchPermissions = docLinks.links.workplaceSearch.permissions;
251269
this.workplaceSearchSalesforce = docLinks.links.workplaceSearch.salesforce;
252270
this.workplaceSearchSecurity = docLinks.links.workplaceSearch.security;
@@ -255,7 +273,9 @@ class DocLinks {
255273
this.workplaceSearchSharePointServer = docLinks.links.workplaceSearch.sharePointServer;
256274
this.workplaceSearchSlack = docLinks.links.workplaceSearch.slack;
257275
this.workplaceSearchSynch = docLinks.links.workplaceSearch.synch;
276+
this.workplaceSearchTeams = docLinks.links.workplaceSearch.teams;
258277
this.workplaceSearchZendesk = docLinks.links.workplaceSearch.zendesk;
278+
this.workplaceSearchZoom = docLinks.links.workplaceSearch.zoom;
259279
}
260280
}
261281

x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/source_data.tsx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export const staticGenericExternalSourceData: SourceDataItem = {
2525
isPublicKey: false,
2626
hasOauthRedirect: false,
2727
needsBaseUrl: false,
28-
documentationUrl: docLinks.workplaceSearchCustomSources, // TODO Update this when we have a doclink
28+
documentationUrl: docLinks.workplaceSearchCustomConnectorPackage,
2929
applicationPortalUrl: '',
3030
},
3131
objTypes: [],
@@ -107,7 +107,7 @@ export const staticSourceData: SourceDataItem[] = [
107107
isPublicKey: false,
108108
hasOauthRedirect: true,
109109
needsBaseUrl: true,
110-
documentationUrl: docLinks.workplaceSearchConfluenceCloud, // TODO Update this when we have a doclink
110+
documentationUrl: docLinks.workplaceSearchConfluenceCloudConnectorPackage,
111111
applicationPortalUrl: 'https://developer.atlassian.com/console/myapps/',
112112
},
113113
objTypes: [
@@ -387,7 +387,7 @@ export const staticSourceData: SourceDataItem[] = [
387387
isPublicKey: false,
388388
hasOauthRedirect: false,
389389
needsBaseUrl: false,
390-
documentationUrl: docLinks.workplaceSearchCustomSources, // TODO Update this when we have a doclink
390+
documentationUrl: docLinks.workplaceSearchNetworkDrive,
391391
applicationPortalUrl: '',
392392
githubRepository: 'elastic/enterprise-search-network-drive-connector',
393393
},
@@ -433,7 +433,7 @@ export const staticSourceData: SourceDataItem[] = [
433433
isPublicKey: false,
434434
hasOauthRedirect: false,
435435
needsBaseUrl: false,
436-
documentationUrl: docLinks.workplaceSearchCustomSources, // TODO Update this when we have a doclink
436+
documentationUrl: docLinks.workplaceSearchOutlook,
437437
applicationPortalUrl: '',
438438
githubRepository: 'elastic/enterprise-search-outlook-connector',
439439
},
@@ -649,7 +649,7 @@ export const staticSourceData: SourceDataItem[] = [
649649
isPublicKey: false,
650650
hasOauthRedirect: false,
651651
needsBaseUrl: false,
652-
documentationUrl: docLinks.workplaceSearchCustomSources, // TODO Update this when we have a doclink
652+
documentationUrl: docLinks.workplaceSearchTeams,
653653
applicationPortalUrl: '',
654654
githubRepository: 'elastic/enterprise-search-teams-connector',
655655
},
@@ -691,7 +691,7 @@ export const staticSourceData: SourceDataItem[] = [
691691
isPublicKey: false,
692692
hasOauthRedirect: false,
693693
needsBaseUrl: false,
694-
documentationUrl: docLinks.workplaceSearchCustomSources, // TODO Update this when we have a doclink
694+
documentationUrl: docLinks.workplaceSearchZoom,
695695
applicationPortalUrl: '',
696696
githubRepository: 'elastic/enterprise-search-zoom-connector',
697697
},

0 commit comments

Comments
 (0)