Skip to content

Commit

Permalink
[ML] Corrects URL of the create job tips docs page (#53576) (#53643)
Browse files Browse the repository at this point in the history 
* [ML] Corrects URL of the create job tips docs page

* [ML] Update validate_job_view snapshot

* [ML] Update links for influencers to new ML book
  • Loading branch information
@peteharverson
peteharverson authored Dec 20, 2019
1 parent ba5f964 commit 9f86f8a
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 24 deletions.
4 changes: 2 additions & 2 deletions ...l/public/application/components/validate_job/__snapshots__/validate_job_view.test.js.snap
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion x-pack/legacy/plugins/ml/public/application/components/validate_job/validate_job_view.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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/kibana/${metadata.branch}/job-tips.html`;
const jobTipsUrl = `https://www.elastic.co/guide/en/elastic-stack-overview/${metadata.branch}/create-jobs.html#job-tips`;

// don't use something like plugins/ml/../common
// because it won't work with the jest tests
Expand Down
44 changes: 23 additions & 21 deletions x-pack/legacy/plugins/ml/server/models/job_validation/messages.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ export const getMessages = () => {
return messages;
}

const createJobsDocsUrl = `https://www.elastic.co/guide/en/elastic-stack-overview/{{version}}/create-jobs.html`;

return (messages = {
field_not_aggregatable: {
status: 'ERROR',
Expand Down Expand Up @@ -43,7 +45,7 @@ export const getMessages = () => {
fieldName: 'by_field "{{fieldName}}"',
},
}),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#cardinality',
url: `${createJobsDocsUrl}#cardinality`,
},
cardinality_over_field_low: {
status: 'WARNING',
Expand All @@ -57,7 +59,7 @@ export const getMessages = () => {
},
}
),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#cardinality',
url: `${createJobsDocsUrl}#cardinality`,
},
cardinality_over_field_high: {
status: 'WARNING',
Expand All @@ -71,7 +73,7 @@ export const getMessages = () => {
},
}
),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#cardinality',
url: `${createJobsDocsUrl}#cardinality`,
},
cardinality_partition_field: {
status: 'WARNING',
Expand All @@ -85,7 +87,7 @@ export const getMessages = () => {
},
}
),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#cardinality',
url: `${createJobsDocsUrl}#cardinality`,
},
cardinality_model_plot_high: {
status: 'WARNING',
Expand Down Expand Up @@ -155,7 +157,7 @@ export const getMessages = () => {
},
}
),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#bucket-span',
url: `${createJobsDocsUrl}#bucket-span`,
},
bucket_span_high: {
status: 'INFO',
Expand All @@ -166,7 +168,7 @@ export const getMessages = () => {
defaultMessage:
'Bucket span is 1 day or more. Be aware that days are considered as UTC days, not local days.',
}),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#bucket-span',
url: `${createJobsDocsUrl}#bucket-span`,
},
bucket_span_valid: {
status: 'SUCCESS',
Expand Down Expand Up @@ -209,21 +211,21 @@ export const getMessages = () => {
partitionFieldNameParam: `'partition_field_name'`,
},
}),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#detectors',
url: `${createJobsDocsUrl}#detectors`,
},
detectors_empty: {
status: 'ERROR',
text: i18n.translate('xpack.ml.models.jobValidation.messages.detectorsEmptyMessage', {
defaultMessage: 'No detectors were found. At least one detector must be specified.',
}),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#detectors',
url: `${createJobsDocsUrl}#detectors`,
},
detectors_function_empty: {
status: 'ERROR',
text: i18n.translate('xpack.ml.models.jobValidation.messages.detectorsFunctionEmptyMessage', {
defaultMessage: 'One of the detector functions is empty.',
}),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#detectors',
url: `${createJobsDocsUrl}#detectors`,
},
detectors_function_not_empty: {
status: 'SUCCESS',
Expand All @@ -239,7 +241,7 @@ export const getMessages = () => {
defaultMessage: 'Presence of detector functions validated in all detectors.',
}
),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#detectors',
url: `${createJobsDocsUrl}#detectors`,
},
index_fields_invalid: {
status: 'ERROR',
Expand All @@ -260,15 +262,15 @@ export const getMessages = () => {
'The job configuration includes more than 3 influencers. ' +
'Consider using fewer influencers or creating multiple jobs.',
}),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#influencers',
url: 'https://www.elastic.co/guide/en/machine-learning/{{version}}/ml-influencers.html',
},
influencer_low: {
status: 'WARNING',
text: i18n.translate('xpack.ml.models.jobValidation.messages.influencerLowMessage', {
defaultMessage:
'No influencers have been configured. Picking an influencer is strongly recommended.',
}),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#influencers',
url: 'https://www.elastic.co/guide/en/machine-learning/{{version}}/ml-influencers.html',
},
influencer_low_suggestion: {
status: 'WARNING',
Expand All @@ -280,7 +282,7 @@ export const getMessages = () => {
values: { influencerSuggestion: '{{influencerSuggestion}}' },
}
),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#influencers',
url: 'https://www.elastic.co/guide/en/machine-learning/{{version}}/ml-influencers.html',
},
influencer_low_suggestions: {
status: 'WARNING',
Expand All @@ -292,7 +294,7 @@ export const getMessages = () => {
values: { influencerSuggestion: '{{influencerSuggestion}}' },
}
),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#influencers',
url: 'https://www.elastic.co/guide/en/machine-learning/{{version}}/ml-influencers.html',
},
job_id_empty: {
status: 'ERROR',
Expand Down Expand Up @@ -401,7 +403,7 @@ export const getMessages = () => {
text: i18n.translate('xpack.ml.models.jobValidation.messages.successCardinalityMessage', {
defaultMessage: 'Cardinality of detector fields is within recommended bounds.',
}),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#cardinality',
url: `${createJobsDocsUrl}#cardinality`,
},
success_bucket_span: {
status: 'SUCCESS',
Expand All @@ -412,14 +414,14 @@ export const getMessages = () => {
defaultMessage: 'Format of {bucketSpan} is valid and passed validation checks.',
values: { bucketSpan: '"{{bucketSpan}}"' },
}),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#bucket-span',
url: `${createJobsDocsUrl}#bucket-span`,
},
success_influencers: {
status: 'SUCCESS',
text: i18n.translate('xpack.ml.models.jobValidation.messages.successInfluencersMessage', {
defaultMessage: 'Influencer configuration passed the validation checks.',
}),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#influencers',
url: 'https://www.elastic.co/guide/en/machine-learning/{{version}}/ml-influencers.html',
},
estimated_mml_greater_than_max_mml: {
status: 'WARNING',
Expand All @@ -446,7 +448,7 @@ export const getMessages = () => {
'1MB and should be specified in bytes e.g. 10MB.',
values: { mml: '{{mml}}' },
}),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#model-memory-limits',
url: `${createJobsDocsUrl}#model-memory-limits`,
},
half_estimated_mml_greater_than_mml: {
status: 'WARNING',
Expand All @@ -458,7 +460,7 @@ export const getMessages = () => {
'memory limit and will likely hit the hard limit.',
}
),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#model-memory-limits',
url: `${createJobsDocsUrl}#model-memory-limits`,
},
estimated_mml_greater_than_mml: {
status: 'INFO',
Expand All @@ -469,7 +471,7 @@ export const getMessages = () => {
'The estimated model memory limit is greater than the model memory limit you have configured.',
}
),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#model-memory-limits',
url: `${createJobsDocsUrl}#model-memory-limits`,
},
success_mml: {
status: 'SUCCESS',
Expand All @@ -479,7 +481,7 @@ export const getMessages = () => {
text: i18n.translate('xpack.ml.models.jobValidation.messages.successMmlMessage', {
defaultMessage: 'Valid and within the estimated model memory limit.',
}),
url: 'https://www.elastic.co/guide/en/kibana/{{version}}/job-tips.html#model-memory-limits',
url: `${createJobsDocsUrl}#model-memory-limits`,
},
success_time_range: {
status: 'SUCCESS',
Expand Down

0 comments on commit 9f86f8a

Please sign in to comment.