Skip to content

[ML] Use documentation link service in more ML pages #87389

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

Merged
merged 4 commits into from
Jan 11, 2021
Merged

[ML] Use documentation link service in more ML pages #87389

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fd63843
[ML] Use documentation link service in more ML pages
lcawl Jan 5, 2021
34d94f8
Fix jest snapshots
lcawl Jan 5, 2021
90f1c59
Merge branch 'master' into ml-doclinks
kibanamachine Jan 7, 2021
a177137
Merge branch 'master' into ml-doclinks
kibanamachine Jan 11, 2021
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
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.

3 changes: 1 addition & 2 deletions x-pack/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 @@ -479,8 +479,7 @@ class RuleEditorFlyoutUI extends Component {
};

render() {
const { ELASTIC_WEBSITE_URL, DOC_LINK_VERSION } = this.props.kibana.services.docLinks;
const docsUrl = `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/ml-rules.html`;
const docsUrl = this.props.kibana.services.docLinks.links.ml.customRules;
const {
isFlyoutVisible,
job,
Expand Down
7 changes: 5 additions & 2 deletions x-pack/plugins/ml/public/application/components/rule_editor/rule_editor_flyout.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,11 @@ function prepareTest() {
kibana: {
services: {
docLinks: {
ELASTIC_WEBSITE_URL: 'https://www.elastic.co/',
DOC_LINK_VERSION: 'jest-metadata-mock-branch',
links: {
ml: {
customRules: 'jest-metadata-mock-url',
},
},
},
},
},
Expand Down
3 changes: 1 addition & 2 deletions x-pack/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 @@ -309,8 +309,7 @@ export class ValidateJobUI extends Component {
};

render() {
const { ELASTIC_WEBSITE_URL, DOC_LINK_VERSION } = getDocLinks();
const jobTipsUrl = `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/create-jobs.html#job-tips`;
const jobTipsUrl = getDocLinks().links.ml.anomalyDetectionJobTips;
// only set to false if really false and not another falsy value, so it defaults to true.
const fill = this.props.fill === false ? false : true;
// default to false if not explicitly set to true
Expand Down
7 changes: 5 additions & 2 deletions x-pack/plugins/ml/public/application/components/validate_job/validate_job_view.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,11 @@ import { ValidateJob } from './validate_job_view';

jest.mock('../../util/dependency_cache', () => ({
getDocLinks: () => ({
ELASTIC_WEBSITE_URL: 'https://www.elastic.co/',
DOC_LINK_VERSION: 'jest-metadata-mock-branch',
links: {
ml: {
anomalyDetectionJobTips: 'jest-metadata-mock-url',
},
},
}),
}));

Expand Down
8 changes: 2 additions & 6 deletions ...ta_frame_analytics/pages/analytics_creation/components/details_step/details_step_form.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,7 @@ export const DetailsStepForm: FC<CreateAnalyticsStepProps> = ({
const {
services: { docLinks, notifications },
} = useMlKibana();
const { ELASTIC_WEBSITE_URL, DOC_LINK_VERSION } = docLinks;

const createIndexLink = docLinks.links.apis.createIndex;
const { setFormState } = actions;
const { form, cloneJob, hasSwitchedToEditor, isJobCreated } = state;
const {
Expand Down Expand Up @@ -240,10 +239,7 @@ export const DetailsStepForm: FC<CreateAnalyticsStepProps> = ({
}
)}
<br />
<EuiLink
href={`${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/reference/${DOC_LINK_VERSION}/indices-create-index.html#indices-create-index`}
target="_blank"
>
<EuiLink href={createIndexLink} target="_blank">
Copy link
Contributor

@peteharverson peteharverson Jan 7, 2021

Choose a reason for hiding this comment

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

Just wondering, where we use an EuiLink in this way, should the text end with a . ? Some places we end with a . and some we don't.

image

I prefer without the .

image

Copy link
Contributor Author

@lcawl lcawl Jan 7, 2021

Choose a reason for hiding this comment

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

There's an example of "Learn more" with an ending period in https://elastic.github.io/eui/#/guidelines/writing and a quick chat with @gchaps indicates it's preferred in general. I will open a separate PR to get consistency on that.

{i18n.translate(
'xpack.ml.dataframe.stepDetailsForm.destinationIndexInvalidErrorLink',
{
Expand Down
2 changes: 1 addition & 1 deletion ...ion/datavisualizer/file_based/components/edit_flyout/__snapshots__/overrides.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.

3 changes: 1 addition & 2 deletions ...ugins/ml/public/application/datavisualizer/file_based/components/edit_flyout/overrides.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,8 +268,7 @@ class OverridesUI extends Component {

const fieldOptions = getSortedFields(fields);
const timestampFormatErrorsList = [this.customTimestampFormatErrors, timestampFormatError];
const { ELASTIC_WEBSITE_URL, DOC_LINK_VERSION } = this.props.kibana.services.docLinks;
const docsUrl = `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/reference/${DOC_LINK_VERSION}/search-aggregations-bucket-daterange-aggregation.html#date-format-pattern`;
const docsUrl = this.props.kibana.services.docLinks.links.aggs.date_format_pattern;

const timestampFormatHelp = (
<EuiText size="xs">
Expand Down
7 changes: 5 additions & 2 deletions .../ml/public/application/datavisualizer/file_based/components/edit_flyout/overrides.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,11 @@ function getProps() {
kibana: {
services: {
docLinks: {
ELASTIC_WEBSITE_URL: 'https://www.elastic.co/',
DOC_LINK_VERSION: 'jest-metadata-mock-branch',
links: {
aggs: {
date_format_pattern: 'jest-metadata-mock-url',
},
},
},
},
},
Expand Down
2 changes: 1 addition & 1 deletion ...k/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.

4 changes: 0 additions & 4 deletions x-pack/plugins/ml/public/application/settings/calendars/list/calendars_list.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,10 +117,6 @@ const props = {
addDanger: () => {},
},
},
docLinks: {
ELASTIC_WEBSITE_URL: 'https://www.elastic.co/',
DOC_LINK_VERSION: 'jest-metadata-mock-branch',
},
},
},
};
Expand Down
4 changes: 1 addition & 3 deletions x-pack/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,9 +26,7 @@ import {
import { withKibana } from '../../../../../../../../src/plugins/kibana_react/public';

function CalendarsListHeaderUI({ totalCount, refreshCalendars, kibana }) {
const { ELASTIC_WEBSITE_URL, DOC_LINK_VERSION } = kibana.services.docLinks;

const docsUrl = `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/ml-calendars.html`;
const docsUrl = kibana.services.docLinks.links.ml.calendars;
return (
<React.Fragment>
<EuiFlexGroup justifyContent="spaceBetween" alignItems="baseline">
Expand Down
7 changes: 5 additions & 2 deletions x-pack/plugins/ml/public/application/settings/calendars/list/header.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,11 @@ describe('CalendarListsHeader', () => {
kibana: {
services: {
docLinks: {
ELASTIC_WEBSITE_URL: 'https://www.elastic.co/',
DOC_LINK_VERSION: 'jest-metadata-mock-branch',
links: {
ml: {
calendars: 'jest-metadata-mock-url',
},
},
},
},
},
Expand Down
3 changes: 1 addition & 2 deletions x-pack/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,8 +26,7 @@ import {
import { withKibana } from '../../../../../../../../src/plugins/kibana_react/public';

function FilterListsHeaderUI({ totalCount, refreshFilterLists, kibana }) {
const { ELASTIC_WEBSITE_URL, DOC_LINK_VERSION } = kibana.services.docLinks;
const docsUrl = `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/ml-rules.html`;
const docsUrl = kibana.services.docLinks.links.ml.customRules;
return (
<React.Fragment>
<EuiFlexGroup justifyContent="spaceBetween" alignItems="baseline">
Expand Down