Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ML] Fixing management app docs links #130776

Merged
merged 2 commits into from
Apr 21, 2022
Merged

[ML] Fixing management app docs links #130776

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54b903a
[ML] Fixing management app docs links
jgowdyelastic Apr 21, 2022
ae744f2
changing translation id
jgowdyelastic Apr 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/kbn-doc-links/src/get_doc_links.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,7 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
regressionEvaluation: `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/ml-dfa-regression.html#ml-dfanalytics-regression-evaluation`,
classificationAucRoc: `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/ml-dfa-classification.html#ml-dfanalytics-class-aucroc`,
setUpgradeMode: `${ELASTICSEARCH_DOCS}ml-set-upgrade-mode.html`,
trainedModels: `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/ml-trained-models.html`,
},
transforms: {
guide: `${ELASTICSEARCH_DOCS}transforms.html`,
Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugins/ml/public/application/management/breadcrumbs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export function getJobsListBreadcrumbs() {
return [
{
text: i18n.translate('xpack.ml.jobsList.breadcrumb', {
peteharverson marked this conversation as resolved.
Show resolved Hide resolved
defaultMessage: 'Jobs',
defaultMessage: 'Machine Learning',
}),
href: `#${JOBS_LIST_PATH}`,
},
Expand Down
60 changes: 34 additions & 26 deletions ...s/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ import { PLUGIN_ID } from '../../../../../../common/constants/app';

import { checkGetManagementMlJobsResolver } from '../../../../capabilities/check_capabilities';

import { getDocLinks } from '../../../../util/dependency_cache';
// @ts-ignore undeclared module
import { JobsListView } from '../../../../jobs/jobs_list/components/jobs_list_view';
import { DataFrameAnalyticsList } from '../../../../data_frame_analytics/pages/analytics_management/components/analytics_list';
Expand All @@ -54,6 +53,7 @@ import { ListingPageUrlState } from '../../../../../../common/types/common';
import { getDefaultDFAListState } from '../../../../data_frame_analytics/pages/analytics_management/page';
import { ExportJobsFlyout, ImportJobsFlyout } from '../../../../components/import_export_jobs';
import type { JobType, MlSavedObjectType } from '../../../../../../common/types/saved_objects';
import { useMlKibana } from '../../../../contexts/kibana';

interface Tab extends EuiTabbedContentTab {
'data-test-subj': string;
Expand Down Expand Up @@ -201,30 +201,6 @@ export const JobsListPage: FC<{
return null;
}

const anomalyDetectionJobsUrl = getDocLinks().links.ml.anomalyDetectionJobs;
const dataFrameAnalyticsUrl = getDocLinks().links.ml.dataFrameAnalytics;

const anomalyDetectionDocsLabel = i18n.translate(
'xpack.ml.management.jobsList.anomalyDetectionDocsLabel',
{
defaultMessage: 'Anomaly detection jobs docs',
}
);
const analyticsDocsLabel = i18n.translate('xpack.ml.management.jobsList.analyticsDocsLabel', {
defaultMessage: 'Analytics jobs docs',
});

const docsLink = (
<EuiButtonEmpty
href={currentTabId === 'anomaly-detector' ? anomalyDetectionJobsUrl : dataFrameAnalyticsUrl}
target="_blank"
iconType="help"
data-test-subj="documentationLink"
>
{currentTabId === 'anomaly-detector' ? anomalyDetectionDocsLabel : analyticsDocsLabel}
</EuiButtonEmpty>
);

function renderTabs() {
return (
<EuiTabbedContent
Expand Down Expand Up @@ -280,7 +256,7 @@ export const JobsListPage: FC<{
defaultMessage="View, export, and import machine learning analytics and anomaly detection items."
/>
}
rightSideItems={[docsLink]}
rightSideItems={[<DocsLink currentTabId={currentTabId} />]}
bottomBorder
/>

Expand Down Expand Up @@ -329,3 +305,35 @@ export const JobsListPage: FC<{
</RedirectAppLinks>
);
};

const DocsLink: FC<{ currentTabId: MlSavedObjectType }> = ({ currentTabId }) => {
const {
services: {
docLinks: {
links: { ml },
},
},
} = useMlKibana();

let href = ml.anomalyDetectionJobs;
let linkLabel = i18n.translate('xpack.ml.management.jobsList.anomalyDetectionDocsLabel', {
defaultMessage: 'Anomaly detection jobs docs',
});

if (currentTabId === 'data-frame-analytics') {
href = ml.dataFrameAnalytics;
linkLabel = i18n.translate('xpack.ml.management.jobsList.analyticsDocsLabel', {
defaultMessage: 'Analytics jobs docs',
});
} else if (currentTabId === 'trained-model') {
href = ml.trainedModels;
linkLabel = i18n.translate('xpack.ml.management.jobsList.trainedModelsDocsLabel', {
defaultMessage: 'Trained models docs',
});
}
return (
<EuiButtonEmpty href={href} target="_blank" iconType="help" data-test-subj="documentationLink">
{linkLabel}
</EuiButtonEmpty>
);
};