Skip to content

Commit

Permalink
[Workplace Search] Add documentation links for v8.3.0 connectors (ela…
Browse files Browse the repository at this point in the history 
…stic#132547)
  • Loading branch information
Byron Hulcher authored May 20, 2022
1 parent c244883 commit 583d2b7
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 6 deletions.
6 changes: 6 additions & 0 deletions packages/kbn-doc-links/src/get_doc_links.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,9 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
apiKeys: `${WORKPLACE_SEARCH_DOCS}workplace-search-api-authentication.html`,
box: `${WORKPLACE_SEARCH_DOCS}workplace-search-box-connector.html`,
confluenceCloud: `${WORKPLACE_SEARCH_DOCS}workplace-search-confluence-cloud-connector.html`,
confluenceCloudConnectorPackage: `${WORKPLACE_SEARCH_DOCS}confluence-cloud.html`,
confluenceServer: `${WORKPLACE_SEARCH_DOCS}workplace-search-confluence-server-connector.html`,
customConnectorPackage: `${WORKPLACE_SEARCH_DOCS}custom-connector-package.html`,
customSources: `${WORKPLACE_SEARCH_DOCS}workplace-search-custom-api-sources.html`,
customSourcePermissions: `${WORKPLACE_SEARCH_DOCS}workplace-search-custom-api-sources.html#custom-api-source-document-level-access-control`,
documentPermissions: `${WORKPLACE_SEARCH_DOCS}workplace-search-sources-document-permissions.html`,
Expand All @@ -139,7 +141,9 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
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`,
networkDrive: `${WORKPLACE_SEARCH_DOCS}network-drives.html`,
oneDrive: `${WORKPLACE_SEARCH_DOCS}workplace-search-onedrive-connector.html`,
outlook: `${WORKPLACE_SEARCH_DOCS}microsoft-outlook.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`,
Expand All @@ -148,7 +152,9 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
sharePointServer: `${WORKPLACE_SEARCH_DOCS}sharepoint-server.html`,
slack: `${WORKPLACE_SEARCH_DOCS}workplace-search-slack-connector.html`,
synch: `${WORKPLACE_SEARCH_DOCS}workplace-search-customizing-indexing-rules.html`,
teams: `${WORKPLACE_SEARCH_DOCS}microsoft-teams.html`,
zendesk: `${WORKPLACE_SEARCH_DOCS}workplace-search-zendesk-connector.html`,
zoom: `${WORKPLACE_SEARCH_DOCS}zoom.html`,
},
metricbeat: {
base: `${ELASTIC_WEBSITE_URL}guide/en/beats/metricbeat/${DOC_LINK_VERSION}`,
Expand Down
6 changes: 6 additions & 0 deletions packages/kbn-doc-links/src/types.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,9 @@ export interface DocLinks {
readonly apiKeys: string;
readonly box: string;
readonly confluenceCloud: string;
readonly confluenceCloudConnectorPackage: string;
readonly confluenceServer: string;
readonly customConnectorPackage: string;
readonly customSources: string;
readonly customSourcePermissions: string;
readonly documentPermissions: string;
Expand All @@ -125,7 +127,9 @@ export interface DocLinks {
readonly indexingSchedule: string;
readonly jiraCloud: string;
readonly jiraServer: string;
readonly networkDrive: string;
readonly oneDrive: string;
readonly outlook: string;
readonly permissions: string;
readonly salesforce: string;
readonly security: string;
Expand All @@ -134,7 +138,9 @@ export interface DocLinks {
readonly sharePointServer: string;
readonly slack: string;
readonly synch: string;
readonly teams: string;
readonly zendesk: string;
readonly zoom: string;
};
readonly heartbeat: {
readonly base: string;
Expand Down
20 changes: 20 additions & 0 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 @@ -64,7 +64,9 @@ class DocLinks {
public workplaceSearchApiKeys: string;
public workplaceSearchBox: string;
public workplaceSearchConfluenceCloud: string;
public workplaceSearchConfluenceCloudConnectorPackage: string;
public workplaceSearchConfluenceServer: string;
public workplaceSearchCustomConnectorPackage: string;
public workplaceSearchCustomSources: string;
public workplaceSearchCustomSourcePermissions: string;
public workplaceSearchDocumentPermissions: string;
Expand All @@ -78,7 +80,9 @@ class DocLinks {
public workplaceSearchIndexingSchedule: string;
public workplaceSearchJiraCloud: string;
public workplaceSearchJiraServer: string;
public workplaceSearchNetworkDrive: string;
public workplaceSearchOneDrive: string;
public workplaceSearchOutlook: string;
public workplaceSearchPermissions: string;
public workplaceSearchSalesforce: string;
public workplaceSearchSecurity: string;
Expand All @@ -87,7 +91,9 @@ class DocLinks {
public workplaceSearchSharePointServer: string;
public workplaceSearchSlack: string;
public workplaceSearchSynch: string;
public workplaceSearchTeams: string;
public workplaceSearchZendesk: string;
public workplaceSearchZoom: string;

constructor() {
this.appSearchApis = '';
Expand Down Expand Up @@ -146,7 +152,9 @@ class DocLinks {
this.workplaceSearchApiKeys = '';
this.workplaceSearchBox = '';
this.workplaceSearchConfluenceCloud = '';
this.workplaceSearchConfluenceCloudConnectorPackage = '';
this.workplaceSearchConfluenceServer = '';
this.workplaceSearchCustomConnectorPackage = '';
this.workplaceSearchCustomSources = '';
this.workplaceSearchCustomSourcePermissions = '';
this.workplaceSearchDocumentPermissions = '';
Expand All @@ -160,7 +168,9 @@ class DocLinks {
this.workplaceSearchIndexingSchedule = '';
this.workplaceSearchJiraCloud = '';
this.workplaceSearchJiraServer = '';
this.workplaceSearchNetworkDrive = '';
this.workplaceSearchOneDrive = '';
this.workplaceSearchOutlook = '';
this.workplaceSearchPermissions = '';
this.workplaceSearchSalesforce = '';
this.workplaceSearchSecurity = '';
Expand All @@ -169,7 +179,9 @@ class DocLinks {
this.workplaceSearchSharePointServer = '';
this.workplaceSearchSlack = '';
this.workplaceSearchSynch = '';
this.workplaceSearchTeams = '';
this.workplaceSearchZendesk = '';
this.workplaceSearchZoom = '';
}

public setDocLinks(docLinks: DocLinksStart): void {
Expand Down Expand Up @@ -230,7 +242,11 @@ class DocLinks {
this.workplaceSearchApiKeys = docLinks.links.workplaceSearch.apiKeys;
this.workplaceSearchBox = docLinks.links.workplaceSearch.box;
this.workplaceSearchConfluenceCloud = docLinks.links.workplaceSearch.confluenceCloud;
this.workplaceSearchConfluenceCloudConnectorPackage =
docLinks.links.workplaceSearch.confluenceCloudConnectorPackage;
this.workplaceSearchConfluenceServer = docLinks.links.workplaceSearch.confluenceServer;
this.workplaceSearchCustomConnectorPackage =
docLinks.links.workplaceSearch.customConnectorPackage;
this.workplaceSearchCustomSources = docLinks.links.workplaceSearch.customSources;
this.workplaceSearchCustomSourcePermissions =
docLinks.links.workplaceSearch.customSourcePermissions;
Expand All @@ -246,7 +262,9 @@ class DocLinks {
this.workplaceSearchIndexingSchedule = docLinks.links.workplaceSearch.indexingSchedule;
this.workplaceSearchJiraCloud = docLinks.links.workplaceSearch.jiraCloud;
this.workplaceSearchJiraServer = docLinks.links.workplaceSearch.jiraServer;
this.workplaceSearchNetworkDrive = docLinks.links.workplaceSearch.networkDrive;
this.workplaceSearchOneDrive = docLinks.links.workplaceSearch.oneDrive;
this.workplaceSearchOutlook = docLinks.links.workplaceSearch.outlook;
this.workplaceSearchPermissions = docLinks.links.workplaceSearch.permissions;
this.workplaceSearchSalesforce = docLinks.links.workplaceSearch.salesforce;
this.workplaceSearchSecurity = docLinks.links.workplaceSearch.security;
Expand All @@ -255,7 +273,9 @@ class DocLinks {
this.workplaceSearchSharePointServer = docLinks.links.workplaceSearch.sharePointServer;
this.workplaceSearchSlack = docLinks.links.workplaceSearch.slack;
this.workplaceSearchSynch = docLinks.links.workplaceSearch.synch;
this.workplaceSearchTeams = docLinks.links.workplaceSearch.teams;
this.workplaceSearchZendesk = docLinks.links.workplaceSearch.zendesk;
this.workplaceSearchZoom = docLinks.links.workplaceSearch.zoom;
}
}

Expand Down
12 changes: 6 additions & 6 deletions ...erprise_search/public/applications/workplace_search/views/content_sources/source_data.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export const staticGenericExternalSourceData: SourceDataItem = {
isPublicKey: false,
hasOauthRedirect: false,
needsBaseUrl: false,
documentationUrl: docLinks.workplaceSearchCustomSources, // TODO Update this when we have a doclink
documentationUrl: docLinks.workplaceSearchCustomConnectorPackage,
applicationPortalUrl: '',
},
objTypes: [],
Expand Down Expand Up @@ -107,7 +107,7 @@ export const staticSourceData: SourceDataItem[] = [
isPublicKey: false,
hasOauthRedirect: true,
needsBaseUrl: true,
documentationUrl: docLinks.workplaceSearchConfluenceCloud, // TODO Update this when we have a doclink
documentationUrl: docLinks.workplaceSearchConfluenceCloudConnectorPackage,
applicationPortalUrl: 'https://developer.atlassian.com/console/myapps/',
},
objTypes: [
Expand Down Expand Up @@ -387,7 +387,7 @@ export const staticSourceData: SourceDataItem[] = [
isPublicKey: false,
hasOauthRedirect: false,
needsBaseUrl: false,
documentationUrl: docLinks.workplaceSearchCustomSources, // TODO Update this when we have a doclink
documentationUrl: docLinks.workplaceSearchNetworkDrive,
applicationPortalUrl: '',
githubRepository: 'elastic/enterprise-search-network-drive-connector',
},
Expand Down Expand Up @@ -433,7 +433,7 @@ export const staticSourceData: SourceDataItem[] = [
isPublicKey: false,
hasOauthRedirect: false,
needsBaseUrl: false,
documentationUrl: docLinks.workplaceSearchCustomSources, // TODO Update this when we have a doclink
documentationUrl: docLinks.workplaceSearchOutlook,
applicationPortalUrl: '',
githubRepository: 'elastic/enterprise-search-outlook-connector',
},
Expand Down Expand Up @@ -649,7 +649,7 @@ export const staticSourceData: SourceDataItem[] = [
isPublicKey: false,
hasOauthRedirect: false,
needsBaseUrl: false,
documentationUrl: docLinks.workplaceSearchCustomSources, // TODO Update this when we have a doclink
documentationUrl: docLinks.workplaceSearchTeams,
applicationPortalUrl: '',
githubRepository: 'elastic/enterprise-search-teams-connector',
},
Expand Down Expand Up @@ -691,7 +691,7 @@ export const staticSourceData: SourceDataItem[] = [
isPublicKey: false,
hasOauthRedirect: false,
needsBaseUrl: false,
documentationUrl: docLinks.workplaceSearchCustomSources, // TODO Update this when we have a doclink
documentationUrl: docLinks.workplaceSearchZoom,
applicationPortalUrl: '',
githubRepository: 'elastic/enterprise-search-zoom-connector',
},
Expand Down

0 comments on commit 583d2b7

Please sign in to comment.