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

Jump to bottom

[Enterprise Search] Minor Elastic Cloud setup guide instructions fixes #89620

Merged
merged 5 commits into from
Jan 29, 2021
Merged

[Enterprise Search] Minor Elastic Cloud setup guide instructions fixes #89620

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
22e10b4
Fix Cloud instructions copy when cloudDeploymentLink is missing
cee-chen Jan 28, 2021
fdaecca
Fix missing i18n translations on copy nested within links
cee-chen Jan 28, 2021
cd414aa
Merge branch 'master' into fix-cloud-instructions
kibanamachine Jan 28, 2021
8a42281
Merge branch 'master' into fix-cloud-instructions
kibanamachine Jan 28, 2021
a10afa0
Merge branch 'master' into fix-cloud-instructions
kibanamachine Jan 28, 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
20 changes: 16 additions & 4 deletions ...k/plugins/enterprise_search/public/applications/shared/setup_guide/cloud/instructions.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,16 @@ export const CloudSetupInstructions: React.FC<Props> = ({ productName, cloudDepl
values={{
editDeploymentLink: cloudDeploymentLink ? (
<EuiLink href={cloudDeploymentLink + '/edit'} target="_blank">
edit your deployment
{i18n.translate(
'xpack.enterpriseSearch.setupGuide.cloud.step1.instruction1LinkText',
Copy link
Contributor

Choose a reason for hiding this comment

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

Is the 1 in instruction1LinkText intentional?

Copy link
Member Author

@cee-chen cee-chen Jan 28, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Yes, they are all intentional in that they match the parent i18n ID, e.g.:

  • xpack.enterpriseSearch.setupGuide.cloud.step1.instruction1
  • xpack.enterpriseSearch.setupGuide.cloud.step3.instruction1
  • xpack.enterpriseSearch.setupGuide.cloud.step5.instruction1

I numbered them in case we ever update instruction copy to have multiple paragraphs, then we can just do instruction1, instruction2, etc. Not 100% sure if that's correct as a best practice, but it's the way it currently is already

{ defaultMessage: 'edit your deployment' }
)}
</EuiLink>
) : (
'Visit the Elastic Cloud console'
i18n.translate(
'xpack.enterpriseSearch.setupGuide.cloud.step1.instruction1LinkText',
{ defaultMessage: 'edit your deployment' }
)
Comment on lines +37 to +46
Copy link
Member Author

Choose a reason for hiding this comment

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

I thought about DRYing this out but was lazy about it, would prefer to address later if possible since there's some time considerations in getting this fix in

),
}}
/>
Expand Down Expand Up @@ -76,7 +82,10 @@ export const CloudSetupInstructions: React.FC<Props> = ({ productName, cloudDepl
href={`${ENT_SEARCH_DOCS_PREFIX}/configuration.html`}
target="_blank"
>
configurable options
{i18n.translate(
'xpack.enterpriseSearch.setupGuide.cloud.step3.instruction1LinkText',
{ defaultMessage: 'configurable options' }
)}
</EuiLink>
),
}}
Expand Down Expand Up @@ -118,7 +127,10 @@ export const CloudSetupInstructions: React.FC<Props> = ({ productName, cloudDepl
href={`${CLOUD_DOCS_PREFIX}/ec-configure-index-management.html`}
target="_blank"
>
configure an index lifecycle policy
{i18n.translate(
'xpack.enterpriseSearch.setupGuide.cloud.step5.instruction1LinkText',
{ defaultMessage: 'configure an index lifecycle policy' }
)}
</EuiLink>
),
}}
Expand Down