[8.9] Add ESRE landing page sections #159809

demjened · 2023-06-15T14:13:19Z

Summary

This PR continues #159589 and adds 4 sections to the ESRE landing page, with a few caveats - these will be addressed in subsequent PRs:

The accordions only have placeholders for inner content
Multiple accordions can be opened at the same time
Links are missing

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
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)

…-ref HEAD~1..HEAD --fix'

demjened · 2023-06-15T14:19:36Z

x-pack/plugins/enterprise_search/public/applications/esre/components/esre_guide/esre_guide.tsx

      pageHeader={{
        pageTitle: i18n.translate('xpack.enterpriseSearch.esre.guide.pageTitle', {
          defaultMessage: 'Enhance your search with ESRE',
        }),
      }}
    >
      <SetPageChrome />
-      <p>ESRE placeholder</p>
+      <EuiPanel color="transparent" paddingSize="none">


I decided to use EuiPanel instead of <EuiPageTemplate.Section>. I had issues with padding when using the latter (for example the header is wider than the sections).

...ns/enterprise_search/public/applications/esre/components/esre_guide/esre_guide_accordion.tsx

demjened · 2023-06-15T14:24:01Z

x-pack/plugins/enterprise_search/public/applications/esre/components/esre_guide/esre_guide.tsx

+import { MeasurePerformanceSection } from './measure_performance_section';
+import { RankAggregationSection } from './rank_aggregation_section';
+import { SemanticSearchSection } from './semantic_search_section';
+
 export const EsreGuide: React.FC = () => {


I'm not sure what logic I should cover with unit tests; everything in this PR is using EUI components. Maybe I can add a test that <EsreGuide> renders the custom sections. Thoughts?

I think you're good for now. We will sometimes test components with enzyme, but usually only if there is complex logic controlling rendering.

We also want to start using react-testing-library instead of enzyme for this kind of testing.

demjened · 2023-06-15T15:40:51Z

@elasticmachine merge upstream

...ugins/enterprise_search/public/applications/esre/components/esre_guide/esre_docs_section.tsx

...ns/enterprise_search/public/applications/esre/components/esre_guide/esre_guide_accordion.tsx

x-pack/plugins/enterprise_search/public/applications/esre/components/esre_guide/esre_guide.tsx

...ugins/enterprise_search/public/applications/esre/components/esre_guide/esre_docs_section.tsx

...ns/enterprise_search/public/applications/esre/components/esre_guide/esre_guide_accordion.tsx

...rprise_search/public/applications/esre/components/esre_guide/measure_performance_section.tsx

demjened · 2023-06-15T18:53:45Z

@TattdCodeMonkey @sphilipse I've addressed your comments.

…-fix'

…com/demjened/kibana into demjened/esre-landing-page-sections

TattdCodeMonkey · 2023-06-15T20:42:41Z

x-pack/plugins/enterprise_search/public/applications/esre/components/esre_guide/esre_guide.tsx

+import { MeasurePerformanceSection } from './measure_performance_section';
+import { RankAggregationSection } from './rank_aggregation_section';
+import { SemanticSearchSection } from './semantic_search_section';
+
 export const EsreGuide: React.FC = () => {


I think you're good for now. We will sometimes test components with enzyme, but usually only if there is complex logic controlling rendering.

We also want to start using react-testing-library instead of enzyme for this kind of testing.

kibana-ci · 2023-06-15T21:32:11Z

💚 Build Succeeded

Buildkite Build
Commit: 22196e2

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`enterpriseSearch`	2116	2129	+13

Async chunks

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

id	before	after	diff
`enterpriseSearch`	2.4MB	2.5MB	+28.2KB

Unknown metric groups

ESLint disabled line counts

id	before	after	diff
`enterpriseSearch`	13	15	+2
`securitySolution`	410	414	+4
total			+6

miscellaneous assets size

id	before	after	diff
`enterpriseSearch`	2.1MB	2.6MB	⚠️ +535.9KB

Total ESLint disabled count

id	before	after	diff
`enterpriseSearch`	14	16	+2
`securitySolution`	493	497	+4
total			+6

History

💔 Build #135783 failed ed47fb0
💚 Build #135683 succeeded cc50d58
💔 Build #135640 failed f003455

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

## Summary This PR follows #159809 and adds content to the expandable accordion sections. The 1st accorion (ELSER) is open by default on page visit. We're also adding links in the sections, which point to documentation or to internal Kibana pages (e.g. Behavioral Analytics, Trained Models). New entries are being added to the doc links files. ![ESRE_panels](https://github.com/elastic/kibana/assets/14224983/a50c5705-0192-4a86-8444-9d4b1a9859b2) ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [x] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>

Add sections

8176c7b

demjened added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting Team:EnterpriseSearch v8.9.0 labels Jun 15, 2023

[CI] Auto-commit changed files from 'node scripts/precommit_hook.js -…

f003455

…-ref HEAD~1..HEAD --fix'

demjened commented Jun 15, 2023

View reviewed changes

...ns/enterprise_search/public/applications/esre/components/esre_guide/esre_guide_accordion.tsx Outdated Show resolved Hide resolved

demjened commented Jun 15, 2023

View reviewed changes

Fix clashing i18n keys

efe28b3

demjened marked this pull request as ready for review June 15, 2023 15:36

demjened requested a review from a team June 15, 2023 15:36

Merge branch 'main' into demjened/esre-landing-page-sections

cc50d58

TattdCodeMonkey reviewed Jun 15, 2023

View reviewed changes

sphilipse reviewed Jun 15, 2023

View reviewed changes

demjened added 5 commits June 15, 2023 14:39

CR - accordion children, remove empty parent component

a675cea

Align SVGs, remove alt text

57d8f14

Remove redundant direction prop

52f3bbe

Use h tag for title

69dbc4f

Use props for accordion

e8856bf

demjened requested review from TattdCodeMonkey and sphilipse June 15, 2023 18:51

demjened and others added 4 commits June 15, 2023 15:16

Type declaration

307c568

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

ed47fb0

…-fix'

Remove children prop

db00595

Merge branch 'demjened/esre-landing-page-sections' of https://github.…

22196e2

…com/demjened/kibana into demjened/esre-landing-page-sections

TattdCodeMonkey approved these changes Jun 15, 2023

View reviewed changes

demjened enabled auto-merge (squash) June 15, 2023 20:44

demjened merged commit 323cd25 into elastic:main Jun 15, 2023

demjened deleted the demjened/esre-landing-page-sections branch June 15, 2023 21:53

demjened mentioned this pull request Jun 19, 2023

[8.9] ESRE landing page panels and links #159851

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[8.9] Add ESRE landing page sections #159809

[8.9] Add ESRE landing page sections #159809

demjened commented Jun 15, 2023 •

edited

Loading

demjened Jun 15, 2023

demjened Jun 15, 2023

TattdCodeMonkey Jun 15, 2023 •

edited

Loading

demjened commented Jun 15, 2023

demjened commented Jun 15, 2023

TattdCodeMonkey Jun 15, 2023 •

edited

Loading

kibana-ci commented Jun 15, 2023

ESLint disabled line counts

miscellaneous assets size

Total ESLint disabled count

[8.9] Add ESRE landing page sections #159809

[8.9] Add ESRE landing page sections #159809

Conversation

demjened commented Jun 15, 2023 • edited Loading

Summary

Checklist

demjened Jun 15, 2023

Choose a reason for hiding this comment

demjened Jun 15, 2023

Choose a reason for hiding this comment

TattdCodeMonkey Jun 15, 2023 • edited Loading

Choose a reason for hiding this comment

demjened commented Jun 15, 2023

demjened commented Jun 15, 2023

TattdCodeMonkey Jun 15, 2023 • edited Loading

Choose a reason for hiding this comment

kibana-ci commented Jun 15, 2023

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

ESLint disabled line counts

miscellaneous assets size

Total ESLint disabled count

History

demjened commented Jun 15, 2023 •

edited

Loading

TattdCodeMonkey Jun 15, 2023 •

edited

Loading

TattdCodeMonkey Jun 15, 2023 •

edited

Loading