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.

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

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

Merged
merged 5 commits into from
Jan 29, 2021

Conversation

cee-chen
Copy link
Member

Summary

Matt found a bug with our Cloud instructions slated to ship in 7.11: If cloudDeploymentLink is empty/not passed in, the resulting message is

Visit the Elastic Cloud console to Visit the Elastic Cloud console

but should be

Visit the Elastic Cloud console to edit your deployment.

Checklist

@cee-chen cee-chen added bug Fixes for quality problems that affect the customer experience release_note:skip Skip the PR/issue when compiling release notes v7.11.0 labels Jan 28, 2021
@cee-chen cee-chen requested review from zumwalt and a team January 28, 2021 18:53
@cee-chen cee-chen changed the title Fix cloud instructions [Enterprise Search] Minor Elastic Cloud setup guide instructions fixes Jan 28, 2021
Comment on lines +37 to +46
{i18n.translate(
'xpack.enterpriseSearch.setupGuide.cloud.step1.instruction1LinkText',
{ defaultMessage: 'edit your deployment' }
)}
</EuiLink>
) : (
'Visit the Elastic Cloud console'
i18n.translate(
'xpack.enterpriseSearch.setupGuide.cloud.step1.instruction1LinkText',
{ defaultMessage: 'edit your deployment' }
)
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

@@ -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

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

@cee-chen
Copy link
Member Author

@elasticmachine merge upstream

@cee-chen
Copy link
Member Author

@elasticmachine merge upstream

@cee-chen
Copy link
Member Author

@elasticmachine merge upstream

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
enterpriseSearch 1.8MB 1.8MB +537.0B

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@cee-chen cee-chen merged commit 6a0f97f into elastic:master Jan 29, 2021
@cee-chen cee-chen deleted the fix-cloud-instructions branch January 29, 2021 17:35
cee-chen pushed a commit to cee-chen/kibana that referenced this pull request Jan 29, 2021
elastic#89620)

* Fix Cloud instructions copy when cloudDeploymentLink is missing

* Fix missing i18n translations on copy nested within links

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
cee-chen pushed a commit that referenced this pull request Jan 29, 2021
#89620) (#89761)

* Fix Cloud instructions copy when cloudDeploymentLink is missing

* Fix missing i18n translations on copy nested within links

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
cee-chen pushed a commit that referenced this pull request Jan 29, 2021
#89620) (#89760)

* Fix Cloud instructions copy when cloudDeploymentLink is missing

* Fix missing i18n translations on copy nested within links

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fixes for quality problems that affect the customer experience release_note:skip Skip the PR/issue when compiling release notes v7.11.0 v7.12.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants