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

[DOCS] Updates ML links #53613

Merged
merged 8 commits into from
Jan 7, 2020
Merged

[DOCS] Updates ML links #53613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ed6e473
[DOCS] Updates ML links
lcawl Dec 19, 2019
d44fe09
[DOCS] Fixes typo
lcawl Dec 19, 2019
311faf2
[DOCS] More URL fixes
lcawl Dec 20, 2019
e48a2bf
[DOCS] Reverts doc changes
lcawl Dec 20, 2019
b8d80d5
Merge branch 'master' into fix-ml-links
elasticmachine Dec 20, 2019
ac5258e
Merge branch 'master' into fix-ml-links
elasticmachine Jan 6, 2020
533e5e2
[DOCS] Fixes type check failure
lcawl Jan 7, 2020
63835b1
[DOCS] Fixes failure in X-Pack Jest check
lcawl Jan 7, 2020
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
2 changes: 1 addition & 1 deletion docs/limitations.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ These {stack} features also have limitations that affect {kib}:

include::limitations/nested-objects.asciidoc[]

include::limitations/export-data.asciidoc[]
include::limitations/export-data.asciidoc[]
6 changes: 3 additions & 3 deletions ...l/public/application/components/rule_editor/__snapshots__/rule_editor_flyout.test.js.snap
View file
Open in desktop

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/rule_editor/rule_editor_flyout.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ import { metadata } from 'ui/metadata';
import { FormattedMessage, injectI18n } from '@kbn/i18n/react';

// metadata.branch corresponds to the version used in documentation links.
const docsUrl = `https://www.elastic.co/guide/en/elastic-stack-overview/${metadata.branch}/ml-rules.html`;
const docsUrl = `https://www.elastic.co/guide/en/machine-learning/${metadata.branch}/ml-rules.html`;

export const RuleEditorFlyout = injectI18n(
class RuleEditorFlyout extends Component {
Expand Down
4 changes: 2 additions & 2 deletions ...l/public/application/components/validate_job/__snapshots__/validate_job_view.test.js.snap
View file
Open in desktop

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
Open in desktop
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/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
Expand Down
2 changes: 1 addition & 1 deletion ...nents/job_details_step/components/additional_section/components/calendars/description.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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-calendars.html`;
const docsUrl = `https://www.elastic.co/guide/en/machine-learning/${metadata.branch}/ml-calendars.html`;

export const Description: FC = memo(({ children }) => {
const title = i18n.translate(
Expand Down
2 changes: 1 addition & 1 deletion ...nts/job_details_step/components/additional_section/components/custom_urls/description.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
4 changes: 2 additions & 2 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 @@ -70,8 +70,8 @@ export const JobsListPage: FC<Props> = ({ 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',
Expand Down
2 changes: 1 addition & 1 deletion ...y/plugins/ml/public/application/settings/calendars/list/__snapshots__/header.test.js.snap
View file
Open in desktop

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/settings/calendars/list/header.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import {
import { metadata } from 'ui/metadata';

// metadata.branch corresponds to the version used in documentation links.
const docsUrl = `https://www.elastic.co/guide/en/elastic-stack-overview/${metadata.branch}/ml-calendars.html`;
const docsUrl = `https://www.elastic.co/guide/en/machine-learning/${metadata.branch}/ml-calendars.html`;

export function CalendarsListHeader({ totalCount, refreshCalendars }) {
return (
Expand Down
2 changes: 1 addition & 1 deletion ...lugins/ml/public/application/settings/filter_lists/list/__snapshots__/header.test.js.snap
View file
Open in desktop

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/settings/filter_lists/list/header.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import {
import { metadata } from 'ui/metadata';

// metadata.branch corresponds to the version used in documentation links.
const docsUrl = `https://www.elastic.co/guide/en/elastic-stack-overview/${metadata.branch}/ml-rules.html`;
const docsUrl = `https://www.elastic.co/guide/en/machine-learning/${metadata.branch}/ml-rules.html`;

export function FilterListsHeader({ totalCount, refreshFilterLists }) {
return (
Expand Down
8 changes: 4 additions & 4 deletions x-pack/legacy/plugins/ml/server/models/job_validation/messages.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand All @@ -26,15 +26,15 @@ export const getMessages = () => {
},
}),
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',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You will need to rebase against the changes I made in #53576, and edit all the links in this file to the previous Create anomaly detection jobs page. So the createJobsDocsUrl field I added in my PR needs to be amended to https://www.elastic.co/guide/en/machine-learning/{{version}}/create-jobs.html.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @peteharverson !

},
fields_not_aggregatable: {
status: 'ERROR',
text: i18n.translate('xpack.ml.models.jobValidation.messages.fieldsNotAggregatableMessage', {
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',
Expand Down Expand Up @@ -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',
Expand Down
2 changes: 2 additions & 0 deletions x-pack/legacy/plugins/transform/public/shim.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ export interface Core extends npCore {
esDocBasePath: string;
esPluginDocBasePath: string;
esStackOverviewDocBasePath: string;
esMLDocBasePath: string;
};
docTitle: {
change: typeof docTitle.change;
Expand Down Expand Up @@ -93,6 +94,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,
Expand Down