Add Elasticsearch guide #128190

yakhinvadim · 2022-03-21T17:44:20Z

Summary

This PR adds a new page to the Enterprise Search app with Elasticsearch guide:

And a new panel to get to this page:

The PR is quite big, but 90% of the code is just plain HTML built with EUI components. I recommend reviewing the whole diff and not look at individual commits.

Several things are intentionally skipped:

i18n for language clients (folder elasticsearch_client_instructions). It would be a huge lift to translate all these instructions, but the value is going to be low, because all the language clients docs are in English anyway.
Tests for most components. We will add tests in a separate PR, the goal right now is to merge the main functionality before the FF.
There was a bug where navigating to page keeps the scroll position. I addressed this by doing scroll(0,0) in useEffect, but probably more centralized Enterpise Search-wide solution is needed.

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)

Co-authored-by: joemcelroy <joseph.mcelroy@elastic.co>

include cloud deployment link in UI

…bana into elasticsearch-integration

joemcelroy · 2022-03-28T08:36:33Z

...plications/enterprise_search_overview/components/elasticsearch_guide/elasticsearch_guide.tsx

+  const client = queryString.parse(window.location.search).client;
+  const languageExists = languages.some((language) => language.value === client);
+  const [selectedLanguage, setSelectedLanguage] = useState(
+    languageExists ? (client as string) : 'java'


I suggest moving the string cast to line 44

Yeah, nice catch, useState should usually be higher. But in this case, it seems necessary, because I'm using the languageExists variable that I define above. Or did I misunderstand something?

scottybollinger

Few minor changes. Thanks for helping out with this!

scottybollinger · 2022-03-28T15:59:28Z

...applications/enterprise_search_overview/components/elasticsearch_card/elasticsearch_card.tsx

+          <EuiText size="s">
+            {i18n.translate('xpack.enterpriseSearch.overview.elasticsearchCard.description', {
+              defaultMessage:
+                'Design and build performant, relevant search-powered application or large-scale search implementations directly in Elasticsearch',


We either need to make this change...

Suggested change

'Design and build performant, relevant search-powered application or large-scale search implementations directly in Elasticsearch',

'Design and build a performant, relevant search-powered application or large-scale search implementations directly in Elasticsearch',

...or make "applications" plural:

Suggested change

'Design and build performant, relevant search-powered application or large-scale search implementations directly in Elasticsearch',

'Design and build performant, relevant search-powered applications or large-scale search implementations directly in Elasticsearch',

scottybollinger · 2022-03-28T16:01:40Z

...applications/enterprise_search_overview/components/elasticsearch_card/elasticsearch_card.tsx

+          <div>
+            <EuiButtonTo to={ELASTICSEARCH_GUIDE_PATH}>
+              {i18n.translate('xpack.enterpriseSearch.overview.elasticsearchCard.button', {
+                defaultMessage: 'Get Started',


To be consistent with our writing guidelines, this should be:

Suggested change

defaultMessage: 'Get Started',

defaultMessage: 'Get started',

scottybollinger · 2022-03-28T16:05:08Z

...rprise_search_overview/components/elasticsearch_client_instructions/elasticsearch_dotnet.tsx

+        </ul>
+        <EuiLink
+          target="_blank"
+          href="https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/introduction.html"


We should use the docsLink service for these URLs. It will future-proof these in case the URLs change. This goes for all links in this PR that start with https://www.elastic.co/guide/en/.

scottybollinger · 2022-03-28T16:10:58Z

...ions/enterprise_search_overview/components/elasticsearch_cloud_id/elasticsearch_cloud_id.tsx

+            {i18n.translate(
+              'xpack.enterpriseSearch.overview.elasticsearchCloudId.manageApiKeysLink',
+              {
+                defaultMessage: 'Manage API Keys',


Suggested change

defaultMessage: 'Manage API Keys',

defaultMessage: 'Manage API keys',

…bana into elasticsearch-integration

scottybollinger

Changes LGTM, pending CI

…by client

Looks like it was fixed in `master`, but not in `current` docs. Since the PR is going to master, we could use the corrected link

lcawl

The additions in kbn-doc-links LGTM

kibana-ci · 2022-03-29T00:06:36Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`enterpriseSearch`	1403	1421	+18

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.4MB	1.4MB	+37.9KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`core`	296.5KB	297.9KB	+1.4KB
`enterpriseSearch`	17.2KB	19.9KB	+2.7KB
total			+4.1KB

History

💚 Build #34145 succeeded 8e5aac0
💚 Build #33812 succeeded 45d2450
💚 Build #33710 succeeded 1c18f3d
💚 Build #33637 succeeded 2003a01
💔 Build #33626 failed 62cec10
💔 Build #33581 failed 7f7e43b

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

kibanamachine · 2022-03-29T00:06:49Z

⚪ Backport skipped

The pull request was not backported as there were no branches to backport to. If this is a mistake, please apply the desired version labels or run the backport tool manually.

Manual backport

To create the backport manually run:

node scripts/backport --pr 128190

Questions ?

Please refer to the Backport tool documentation

kibanamachine · 2022-03-31T00:16:19Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 128190 or prevent reminders by adding the backport:skip label.

Vadim Yakhin and others added 9 commits March 21, 2022 10:43

Add basic elasticsearch card and page

594aa1d

Add more content and styles

7722bf9

Update content

b0a906b

Add language client select

fd65d9a

Get client language from URL

5269ebe

Add language instructions

a6603a4

Make designs close to pixel perfect

ca5757b

Add i18n strings

b30f983

Add elasticsearch_cloud_id component and tests

23c556f

Co-authored-by: joemcelroy <joseph.mcelroy@elastic.co>

yakhinvadim added the skip-ci label Mar 22, 2022

Vadim Yakhin and others added 6 commits March 22, 2022 14:40

Fix linter errors

d26fa9b

Use i18n instead of FormattedMessage for consistency

6e409c9

Remove redundant FormattedMessage

d0b73e1

include cloud deployment link in UI

8cab5d1

Add instructions for all language clients

f6a446b

Merge pull request #1 from joemcelroy/cloud-id-my-deployment-link

ec09418

include cloud deployment link in UI

yakhinvadim added ci:deploy-cloud and removed skip-ci labels Mar 24, 2022

Vadim Yakhin added 3 commits March 24, 2022 08:35

Rewrite language selector with switch

02b4c1a

Add missing target blank

b05b498

Remove trailing whitespace in code blocks

9adff32

yakhinvadim changed the title ~~Add basic elasticsearch card and page~~ Add Elasticsearch guide Mar 24, 2022

This comment was marked as outdated.

Sign in to view

kibanamachine and others added 3 commits March 24, 2022 12:15

Merge branch 'main' into elasticsearch-integration

7f7e43b

Merge branch 'elasticsearch-integration' of github.com:yakhinvadim/ki…

445e7e2

…bana into elasticsearch-integration

Fix i18n

62cec10

This comment was marked as outdated.

Sign in to view

Vadim Yakhin added 3 commits March 24, 2022 11:24

Merge branch 'main' into elasticsearch-integration

ab0e65b

Merge branch 'main' into elasticsearch-integration

2003a01

Invert ruby instructions

7d6dd81

yakhinvadim marked this pull request as ready for review March 26, 2022 17:12

yakhinvadim requested review from a team and scottybollinger March 26, 2022 17:12

joemcelroy reviewed Mar 28, 2022

View reviewed changes

scottybollinger suggested changes Mar 28, 2022

View reviewed changes

Vadim Yakhin added 6 commits March 28, 2022 09:43

Fix typo

1da266b

Adhere to writing guidelines

a1fba7f

Merge branch 'elasticsearch-integration' of github.com:yakhinvadim/ki…

05c3d89

…bana into elasticsearch-integration

Merge branch 'main' into elasticsearch-integration

8e5aac0

Use docLinks service

69a8160

Update dotnet guide

38d4837

yakhinvadim requested a review from a team as a code owner March 28, 2022 22:15

scottybollinger approved these changes Mar 28, 2022

View reviewed changes

Vadim Yakhin added 2 commits March 28, 2022 15:39

Use elasticsearch query dsl link instead of creating a new one for Ru…

8ddb0fb

…by client

Update php connecting link

a55f0c9

Looks like it was fixed in `master`, but not in `current` docs. Since the PR is going to master, we could use the corrected link

lcawl approved these changes Mar 28, 2022

View reviewed changes

yakhinvadim enabled auto-merge (squash) March 28, 2022 23:21

yakhinvadim merged commit ecd2a50 into elastic:main Mar 29, 2022

yakhinvadim mentioned this pull request Mar 29, 2022

Add tests to elasticsearch guide #128709

Merged

1 task

kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 31, 2022

yakhinvadim added the backport:skip This commit does not require backporting label Mar 31, 2022

kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 31, 2022

yakhinvadim removed auto-backport Deprecated - use backport:version if exact versions are needed v8.2.0 labels Mar 31, 2022

yakhinvadim mentioned this pull request Apr 1, 2022

Add missing link that is used in elasticsearch guide #129266

Merged

1 task

tylersmalley added ci:cloud-deploy Create or update a Cloud deployment and removed ci:deploy-cloud labels Aug 17, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Elasticsearch guide #128190

Add Elasticsearch guide #128190

yakhinvadim commented Mar 21, 2022 •

edited

Loading

This comment was marked as outdated.

This comment was marked as outdated.

joemcelroy Mar 28, 2022

yakhinvadim Mar 28, 2022

scottybollinger left a comment

scottybollinger Mar 28, 2022

scottybollinger Mar 28, 2022

scottybollinger Mar 28, 2022

scottybollinger Mar 28, 2022

scottybollinger left a comment

lcawl left a comment

kibana-ci commented Mar 29, 2022

kibanamachine commented Mar 29, 2022

kibanamachine commented Mar 31, 2022

	'Design and build performant, relevant search-powered application or large-scale search implementations directly in Elasticsearch',
	'Design and build a performant, relevant search-powered application or large-scale search implementations directly in Elasticsearch',

	defaultMessage: 'Get Started',
	defaultMessage: 'Get started',

	defaultMessage: 'Manage API Keys',
	defaultMessage: 'Manage API keys',

Add Elasticsearch guide #128190

Add Elasticsearch guide #128190

Conversation

yakhinvadim commented Mar 21, 2022 • edited Loading

Summary

Checklist

This comment was marked as outdated.

This comment was marked as outdated.

joemcelroy Mar 28, 2022

Choose a reason for hiding this comment

yakhinvadim Mar 28, 2022

Choose a reason for hiding this comment

scottybollinger left a comment

Choose a reason for hiding this comment

scottybollinger Mar 28, 2022

Choose a reason for hiding this comment

scottybollinger Mar 28, 2022

Choose a reason for hiding this comment

scottybollinger Mar 28, 2022

Choose a reason for hiding this comment

scottybollinger Mar 28, 2022

Choose a reason for hiding this comment

scottybollinger left a comment

Choose a reason for hiding this comment

lcawl left a comment

Choose a reason for hiding this comment

kibana-ci commented Mar 29, 2022

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

History

kibanamachine commented Mar 29, 2022

⚪ Backport skipped

Manual backport

Questions ?

kibanamachine commented Mar 31, 2022

yakhinvadim commented Mar 21, 2022 •

edited

Loading