From ed6e4730e97b890af8430e8f0829e67bdb3f44a5 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 19 Dec 2019 09:35:39 -0800 Subject: [PATCH 1/6] [DOCS] Updates ML links --- docs/limitations.asciidoc | 4 ++-- docs/user/ml/index.asciidoc | 10 +++++----- .../__snapshots__/rule_editor_flyout.test.js.snap | 6 +++--- .../components/rule_editor/rule_editor_flyout.js | 2 +- .../components/calendars/description.tsx | 2 +- .../components/custom_urls/description.tsx | 2 +- .../components/jobs_list_page/jobs_list_page.tsx | 4 ++-- .../calendars/list/__snapshots__/header.test.js.snap | 2 +- .../application/settings/calendars/list/header.js | 2 +- .../list/__snapshots__/header.test.js.snap | 2 +- .../application/settings/filter_lists/list/header.js | 2 +- .../ml/server/models/job_validation/messages.js | 6 +++--- x-pack/legacy/plugins/transform/public/shim.ts | 1 + 13 files changed, 23 insertions(+), 22 deletions(-) diff --git a/docs/limitations.asciidoc b/docs/limitations.asciidoc index 0b26a3cdcf71a..39103c3fa5d80 100644 --- a/docs/limitations.asciidoc +++ b/docs/limitations.asciidoc @@ -1,4 +1,4 @@ -[[limitations]] +{ml-docs}[[limitations]] = Limitations [partintro] @@ -12,7 +12,7 @@ These {stack} features also have limitations that affect {kib}: * {ref}/watcher-limitations.html[Alerting] -* {stack-ov}/ml-limitations.html[Machine learning] +* {ml-docs}/ml-limitations.html[Machine learning] * {ref}/security-limitations.html[Security] -- diff --git a/docs/user/ml/index.asciidoc b/docs/user/ml/index.asciidoc index a2c23aad98d5b..cca0dc5e4530f 100644 --- a/docs/user/ml/index.asciidoc +++ b/docs/user/ml/index.asciidoc @@ -50,8 +50,8 @@ pane: image::user/ml/images/ml-job-management.jpg[Job Management] You can use the *Settings* pane to create and edit -{stack-ov}/ml-calendars.html[calendars] and the filters that are used in -{stack-ov}/ml-rules.html[custom rules]: +{ml-docs}/ml-calendars.html[calendars] and the filters that are used in +{ml-docs}/ml-rules.html[custom rules]: [role="screenshot"] image::user/ml/images/ml-settings.jpg[Calendar Management] @@ -73,7 +73,7 @@ image::user/ml/images/ml-annotations-list.jpg[Single Metric Viewer with annotati In some circumstances, annotations are also added automatically. For example, if the {anomaly-job} detects that there is missing data, it annotates the affected time period. For more information, see -{stack-ov}/ml-delayed-data-detection.html[Handling delayed data]. The +{ml-docs}/ml-delayed-data-detection.html[Handling delayed data]. The *Job Management* pane shows the full list of annotations for each job. NOTE: The {kib} {ml-features} use pop-ups. You must configure your web @@ -82,7 +82,7 @@ browser so that it does not block pop-up windows or create an exception for your For more information about the {anomaly-detect} feature, see https://www.elastic.co/what-is/elastic-stack-machine-learning[{ml-cap} in the {stack}] -and {stack-ov}/xpack-ml.html[{ml-cap} {anomaly-detect}]. +and {ml-docs}/xpack-ml.html[{ml-cap} {anomaly-detect}]. [[xpack-ml-dfanalytics]] == {dfanalytics-cap} @@ -99,4 +99,4 @@ in {kib}. For example: image::user/ml/images/outliers.jpg[{oldetection-cap} results in {kib}] For more information about the {dfanalytics} feature, see -{stack-ov}/ml-dfanalytics.html[{ml-cap} {dfanalytics}]. \ No newline at end of file +{ml-docs}/ml-dfanalytics.html[{ml-cap} {dfanalytics}]. \ No newline at end of file diff --git a/x-pack/legacy/plugins/ml/public/application/components/rule_editor/__snapshots__/rule_editor_flyout.test.js.snap b/x-pack/legacy/plugins/ml/public/application/components/rule_editor/__snapshots__/rule_editor_flyout.test.js.snap index 4486899efb001..3b14025e9cb7b 100644 --- a/x-pack/legacy/plugins/ml/public/application/components/rule_editor/__snapshots__/rule_editor_flyout.test.js.snap +++ b/x-pack/legacy/plugins/ml/public/application/components/rule_editor/__snapshots__/rule_editor_flyout.test.js.snap @@ -101,7 +101,7 @@ exports[`RuleEditorFlyout renders the flyout after adding a condition to a rule values={ Object { "learnMoreLink": { const title = i18n.translate( diff --git a/x-pack/legacy/plugins/ml/public/application/jobs/new_job/pages/components/job_details_step/components/additional_section/components/custom_urls/description.tsx b/x-pack/legacy/plugins/ml/public/application/jobs/new_job/pages/components/job_details_step/components/additional_section/components/custom_urls/description.tsx index 89cd5c252c3d6..566bd313dbc6e 100644 --- a/x-pack/legacy/plugins/ml/public/application/jobs/new_job/pages/components/job_details_step/components/additional_section/components/custom_urls/description.tsx +++ b/x-pack/legacy/plugins/ml/public/application/jobs/new_job/pages/components/job_details_step/components/additional_section/components/custom_urls/description.tsx @@ -10,7 +10,7 @@ import { FormattedMessage } from '@kbn/i18n/react'; import { EuiDescribedFormGroup, EuiFormRow, EuiLink } from '@elastic/eui'; import { metadata } from 'ui/metadata'; -const docsUrl = `https://www.elastic.co/guide/en/elastic-stack-overview/${metadata.branch}/ml-configuring-url.html`; +const docsUrl = `https://www.elastic.co/guide/en/machine-learning/${metadata.branch}/ml-configuring-url.html`; export const Description: FC = memo(({ children }) => { const title = i18n.translate( diff --git a/x-pack/legacy/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx b/x-pack/legacy/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx index a19a27d00e9b0..1591dbcbad6bf 100644 --- a/x-pack/legacy/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx +++ b/x-pack/legacy/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx @@ -70,8 +70,8 @@ export const JobsListPage: FC = ({ isMlEnabledInSpace }) => { const [currentTabId, setCurrentTabId] = useState(tabs[0].id); // metadata.branch corresponds to the version used in documentation links. - const anomalyDetectionJobsUrl = `https://www.elastic.co/guide/en/elastic-stack-overview/${metadata.branch}/ml-jobs.html`; - const anomalyJobsUrl = `https://www.elastic.co/guide/en/elastic-stack-overview/${metadata.branch}/ml-dfanalytics.html`; + const anomalyDetectionJobsUrl = `https://www.elastic.co/guide/en/machine-learning/${metadata.branch}/ml-jobs.html`; + const anomalyJobsUrl = `https://www.elastic.co/guide/en/machine-learning/${metadata.branch}/ml-dfanalytics.html`; const anomalyDetectionDocsLabel = i18n.translate( 'xpack.ml.management.jobsList.anomalyDetectionDocsLabel', diff --git a/x-pack/legacy/plugins/ml/public/application/settings/calendars/list/__snapshots__/header.test.js.snap b/x-pack/legacy/plugins/ml/public/application/settings/calendars/list/__snapshots__/header.test.js.snap index 2d32650a4b788..0b39841ed61e4 100644 --- a/x-pack/legacy/plugins/ml/public/application/settings/calendars/list/__snapshots__/header.test.js.snap +++ b/x-pack/legacy/plugins/ml/public/application/settings/calendars/list/__snapshots__/header.test.js.snap @@ -89,7 +89,7 @@ exports[`CalendarListsHeader renders header 1`] = ` Object { "br":
, "learnMoreLink": , "learnMoreLink": { }, }), url: - 'https://www.elastic.co/guide/en/elastic-stack-overview/{{version}}/ml-configuring-aggregation.html', + 'https://www.elastic.co/guide/en/machine-learning/{{version}}/ml-configuring-aggregation.html', }, fields_not_aggregatable: { status: 'ERROR', @@ -34,7 +34,7 @@ export const getMessages = () => { defaultMessage: 'One of the detector fields is not an aggregatable field.', }), url: - 'https://www.elastic.co/guide/en/elastic-stack-overview/{{version}}/ml-configuring-aggregation.html', + 'https://www.elastic.co/guide/en/machine-learning/{{version}}/ml-configuring-aggregation.html', }, cardinality_by_field: { status: 'WARNING', @@ -112,7 +112,7 @@ export const getMessages = () => { } ), url: - 'https://www.elastic.co/guide/en/elastic-stack-overview/{{version}}/ml-configuring-categories.html', + 'https://www.elastic.co/guide/en/machine-learning/{{version}}/ml-configuring-categories.html', }, categorization_filters_invalid: { status: 'ERROR', diff --git a/x-pack/legacy/plugins/transform/public/shim.ts b/x-pack/legacy/plugins/transform/public/shim.ts index 5d7c309ade211..d8b5c47c2d641 100644 --- a/x-pack/legacy/plugins/transform/public/shim.ts +++ b/x-pack/legacy/plugins/transform/public/shim.ts @@ -93,6 +93,7 @@ export function createPublicShim(): { core: Core; plugins: Plugins } { esDocBasePath: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/reference/${DOC_LINK_VERSION}/`, esPluginDocBasePath: `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/plugins/${DOC_LINK_VERSION}/`, esStackOverviewDocBasePath: `${ELASTIC_WEBSITE_URL}guide/en/elastic-stack-overview/${DOC_LINK_VERSION}/`, + esMLDocBasePath: `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/`, }, docTitle: { change: docTitle.change, From d44fe091263a2228db519da492a57f561c15eccd Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 19 Dec 2019 10:15:24 -0800 Subject: [PATCH 2/6] [DOCS] Fixes typo --- docs/limitations.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/limitations.asciidoc b/docs/limitations.asciidoc index 39103c3fa5d80..9bcba3b65d660 100644 --- a/docs/limitations.asciidoc +++ b/docs/limitations.asciidoc @@ -1,4 +1,4 @@ -{ml-docs}[[limitations]] +[[limitations]] = Limitations [partintro] From 311faf25ee2ff8000eddf9f3d38a581941b263f5 Mon Sep 17 00:00:00 2001 From: lcawl Date: Fri, 20 Dec 2019 08:48:35 -0800 Subject: [PATCH 3/6] [DOCS] More URL fixes --- .../application/components/validate_job/validate_job_view.js | 2 +- .../legacy/plugins/ml/server/models/job_validation/messages.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/x-pack/legacy/plugins/ml/public/application/components/validate_job/validate_job_view.js b/x-pack/legacy/plugins/ml/public/application/components/validate_job/validate_job_view.js index c1296375b5a33..9b92265c4034b 100644 --- a/x-pack/legacy/plugins/ml/public/application/components/validate_job/validate_job_view.js +++ b/x-pack/legacy/plugins/ml/public/application/components/validate_job/validate_job_view.js @@ -27,7 +27,7 @@ import { FormattedMessage } from '@kbn/i18n/react'; import { metadata } from 'ui/metadata'; // metadata.branch corresponds to the version used in documentation links. -const jobTipsUrl = `https://www.elastic.co/guide/en/elastic-stack-overview/${metadata.branch}/create-jobs.html#job-tips`; +const jobTipsUrl = `https://www.elastic.co/guide/en/machine-learning/${metadata.branch}/create-jobs.html#job-tips`; // don't use something like plugins/ml/../common // because it won't work with the jest tests diff --git a/x-pack/legacy/plugins/ml/server/models/job_validation/messages.js b/x-pack/legacy/plugins/ml/server/models/job_validation/messages.js index e31aed4278bd5..2c0c218bf86b5 100644 --- a/x-pack/legacy/plugins/ml/server/models/job_validation/messages.js +++ b/x-pack/legacy/plugins/ml/server/models/job_validation/messages.js @@ -14,7 +14,7 @@ export const getMessages = () => { return messages; } - const createJobsDocsUrl = `https://www.elastic.co/guide/en/elastic-stack-overview/{{version}}/create-jobs.html`; + const createJobsDocsUrl = `https://www.elastic.co/guide/en/machine-learning/{{version}}/create-jobs.html`; return (messages = { field_not_aggregatable: { From e48a2bfee463af94ab07d8583d4b40eec9e54d3e Mon Sep 17 00:00:00 2001 From: lcawl Date: Fri, 20 Dec 2019 09:55:51 -0800 Subject: [PATCH 4/6] [DOCS] Reverts doc changes --- docs/limitations.asciidoc | 4 ++-- docs/user/ml/index.asciidoc | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/limitations.asciidoc b/docs/limitations.asciidoc index 9bcba3b65d660..b93fa749b160d 100644 --- a/docs/limitations.asciidoc +++ b/docs/limitations.asciidoc @@ -12,11 +12,11 @@ These {stack} features also have limitations that affect {kib}: * {ref}/watcher-limitations.html[Alerting] -* {ml-docs}/ml-limitations.html[Machine learning] +* {stack-ov}/ml-limitations.html[Machine learning] * {ref}/security-limitations.html[Security] -- include::limitations/nested-objects.asciidoc[] -include::limitations/export-data.asciidoc[] +include::limitations/export-data.asciidoc[] \ No newline at end of file diff --git a/docs/user/ml/index.asciidoc b/docs/user/ml/index.asciidoc index cca0dc5e4530f..a2c23aad98d5b 100644 --- a/docs/user/ml/index.asciidoc +++ b/docs/user/ml/index.asciidoc @@ -50,8 +50,8 @@ pane: image::user/ml/images/ml-job-management.jpg[Job Management] You can use the *Settings* pane to create and edit -{ml-docs}/ml-calendars.html[calendars] and the filters that are used in -{ml-docs}/ml-rules.html[custom rules]: +{stack-ov}/ml-calendars.html[calendars] and the filters that are used in +{stack-ov}/ml-rules.html[custom rules]: [role="screenshot"] image::user/ml/images/ml-settings.jpg[Calendar Management] @@ -73,7 +73,7 @@ image::user/ml/images/ml-annotations-list.jpg[Single Metric Viewer with annotati In some circumstances, annotations are also added automatically. For example, if the {anomaly-job} detects that there is missing data, it annotates the affected time period. For more information, see -{ml-docs}/ml-delayed-data-detection.html[Handling delayed data]. The +{stack-ov}/ml-delayed-data-detection.html[Handling delayed data]. The *Job Management* pane shows the full list of annotations for each job. NOTE: The {kib} {ml-features} use pop-ups. You must configure your web @@ -82,7 +82,7 @@ browser so that it does not block pop-up windows or create an exception for your For more information about the {anomaly-detect} feature, see https://www.elastic.co/what-is/elastic-stack-machine-learning[{ml-cap} in the {stack}] -and {ml-docs}/xpack-ml.html[{ml-cap} {anomaly-detect}]. +and {stack-ov}/xpack-ml.html[{ml-cap} {anomaly-detect}]. [[xpack-ml-dfanalytics]] == {dfanalytics-cap} @@ -99,4 +99,4 @@ in {kib}. For example: image::user/ml/images/outliers.jpg[{oldetection-cap} results in {kib}] For more information about the {dfanalytics} feature, see -{ml-docs}/ml-dfanalytics.html[{ml-cap} {dfanalytics}]. \ No newline at end of file +{stack-ov}/ml-dfanalytics.html[{ml-cap} {dfanalytics}]. \ No newline at end of file From 533e5e2e4c5a7d43f483125f7b5f41890913dd93 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 7 Jan 2020 09:02:25 -0800 Subject: [PATCH 5/6] [DOCS] Fixes type check failure --- x-pack/legacy/plugins/transform/public/shim.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/x-pack/legacy/plugins/transform/public/shim.ts b/x-pack/legacy/plugins/transform/public/shim.ts index 3f8475cb3a17e..d739dd2edddcc 100644 --- a/x-pack/legacy/plugins/transform/public/shim.ts +++ b/x-pack/legacy/plugins/transform/public/shim.ts @@ -47,6 +47,7 @@ export interface Core extends npCore { esDocBasePath: string; esPluginDocBasePath: string; esStackOverviewDocBasePath: string; + esMLDocBasePath: string; }; docTitle: { change: typeof docTitle.change; From 63835b1337688e9ee9fb089fc4319e061966aa83 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 7 Jan 2020 11:46:13 -0800 Subject: [PATCH 6/6] [DOCS] Fixes failure in X-Pack Jest check --- .../validate_job/__snapshots__/validate_job_view.test.js.snap | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/x-pack/legacy/plugins/ml/public/application/components/validate_job/__snapshots__/validate_job_view.test.js.snap b/x-pack/legacy/plugins/ml/public/application/components/validate_job/__snapshots__/validate_job_view.test.js.snap index 29d10eb99ff4e..fb6b9c7c9db66 100644 --- a/x-pack/legacy/plugins/ml/public/application/components/validate_job/__snapshots__/validate_job_view.test.js.snap +++ b/x-pack/legacy/plugins/ml/public/application/components/validate_job/__snapshots__/validate_job_view.test.js.snap @@ -60,7 +60,7 @@ exports[`ValidateJob renders button and modal with a message 1`] = ` values={ Object { "mlJobTipsLink":