Skip to content

[SR] Add link to index settings docs #40083

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
jen-huang merged 2 commits into from
Jul 1, 2019
Merged

[SR] Add link to index settings docs #40083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
449e9b3
Add link to index settings docs
jen-huang Jul 1, 2019
7a49de1
Fix i18n key
jen-huang Jul 1, 2019
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
21 changes: 19 additions & 2 deletions ...gins/snapshot_restore/public/app/components/restore_snapshot_form/steps/step_settings.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import {
EuiSpacer,
EuiSwitch,
EuiTitle,
EuiLink,
} from '@elastic/eui';
import { RestoreSettings } from '../../../../../common/types';
import { REMOVE_INDEX_SETTINGS_SUGGESTIONS } from '../../../constants';
Expand Down Expand Up @@ -57,6 +58,16 @@ export const RestoreSnapshotStepSettings: React.FunctionComponent<StepProps> = (
}))
);

// Index settings doc link
const indexSettingsDocLink = (
<EuiLink href={documentationLinksService.getIndexSettingsUrl()} target="_blank">
<FormattedMessage
id="xpack.snapshotRestore.restoreForm.stepSettings.indexSettingsDocLinkText"
defaultMessage="Learn more."
/>
</EuiLink>
);

return (
<div className="snapshotRestore__restoreForm__stepSettings">
{/* Step title and doc link */}
Expand Down Expand Up @@ -104,7 +115,10 @@ export const RestoreSnapshotStepSettings: React.FunctionComponent<StepProps> = (
description={
<FormattedMessage
id="xpack.snapshotRestore.restoreForm.stepSettings.indexSettingsDescription"
defaultMessage="Overrides index settings during restore."
defaultMessage="Overrides index settings during restore. {docLink}"
values={{
docLink: indexSettingsDocLink,
}}
/>
}
idAria="stepSettingsIndexSettingsDescription"
Expand Down Expand Up @@ -215,7 +229,10 @@ export const RestoreSnapshotStepSettings: React.FunctionComponent<StepProps> = (
description={
<FormattedMessage
id="xpack.snapshotRestore.restoreForm.stepSettings.ignoreIndexSettingsDescription"
defaultMessage="Resets selected settings to default during restore. "
defaultMessage="Resets selected settings to default during restore. {docLink}"
values={{
docLink: indexSettingsDocLink,
}}
/>
}
idAria="stepSettingsIgnoreIndexSettingsDescription"
Expand Down
4 changes: 4 additions & 0 deletions .../legacy/plugins/snapshot_restore/public/app/services/documentation/documentation_links.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ class DocumentationLinksService {
public getRestoreIndexSettingsUrl() {
return `${this.esDocBasePath}/modules-snapshots.html#_changing_index_settings_during_restore`;
}

public getIndexSettingsUrl() {
return `${this.esDocBasePath}/index-modules.html`;
}
}

export const documentationLinksService = new DocumentationLinksService();