[DataViewField] Allow to add a custom description for data view fields #168577

jughosta · 2023-10-11T09:54:33Z

Closes Add Data field descriptions #89726

Summary

This PR extends Data View Field flyout with a new textarea to enter and save a custom field description. This description will be shown in a field popover for Discover sidebar, in Doc Viewer and also on Data View management page. Current limit for the custom description is 300.

When creating/editing a field:

In the field popover(truncated):

In the field popover(expanded):

In Doc Viewer popover(always expanded):

On Data View Management page(truncated):

Initial implementation examples

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

mattkime · 2023-10-11T21:15:10Z

Suggestion - make the description field a single row and place it beneath the name field. No toggle needed.

I'd prefer to put the description inside the field list hover directly instead of having a hover in the hover. There should be a way of truncating it or perhaps having an expand and collapse.

Perhaps limit it to 255 characters.

It would be nice if the field search could also search descriptions, but that might be a follow up.

ninoslavmiskovic · 2023-10-12T06:40:38Z

@mattkime some good ideas 💡

I would be hesitant to include it in the field list to avoid using up that much space. Also might be look scattered if some fields have descriptions and others don't.

What we could investigate perhaps is adding the "I" icon on the fields that have descriptions on the "main" list and not just the popover.

I agree on placing it near the name (like mentioned on slack).

++ on the limit for 255 characters.

@andreadelrio could charm in.

BTW - we are planning some work on the field list for the near term, where this could be relevant to include.

davismcphee

Looks and works great! I think this would definitely add value for users and is worth proceeding with. In the future we might be able to enhance the functionality with things like automatic descriptions for ECS fields, etc.

Suggestion - make the description field a single row and place it beneath the name field. No toggle needed.

I agree with this. The toggle feels unnecessary already so avoiding another one would be good. If we group them under one toggle, maybe we should rename it to something like "Set details".

I'd prefer to put the description inside the field list hover directly instead of having a hover in the hover. There should be a way of truncating it or perhaps having an expand and collapse.

I also think this could be a good idea. I took a quick attempt at it, were you thinking something along these lines?

What we could investigate perhaps is adding the "I" icon on the fields that have descriptions on the "main" list and not just the popover.

Personally I'd recommend against adding anything to the field list and keeping it only in the popover since the field list can already become crowded with long names and multiple icons.

teresaalvarezsoler · 2023-11-20T11:11:42Z

hey team, this is a great feature, are we planning to show these field description also in Lens? :)

davismcphee · 2023-11-20T22:35:49Z

@teresaalvarezsoler Since it's still in a PoC state I can't say for sure what the final experience will look like, but if we add the descriptions to the field list popover or somewhere else in the field list, then it should also be supported for Lens by default 🙂

…ption # Conflicts: # src/plugins/data_views/common/data_views/data_view.ts

jughosta · 2023-12-22T16:33:50Z

Hi team,
Pushed some updates and here is the current state:

I think it's important to have a textarea for the description and I set the limit to 300 so users can easily enter a longer description for the field. I like having this textarea behind a switch toggle so it does not take much space in the flyout by default.

Let me know if it looks good or more modifications needed before I add tests.

cc @andreadelrio

jughosta · 2023-12-22T16:33:56Z

/ci

…fix'

jughosta · 2023-12-22T16:51:23Z

/ci

…ustom-field-description

jughosta · 2023-12-22T17:45:54Z

/ci

elasticmachine · 2024-03-11T18:37:24Z

Pinging @elastic/kibana-data-discovery (Team:DataDiscovery)

jbudz

limits.yml

mattkime

Code look good and works well. Nice work!

davismcphee

Code changes look good, and I tested locally and it seems to be working well! Great work and LGTM 👍

src/plugins/data_view_field_editor/public/components/field_editor/field_detail.tsx

stratoula

Vis team changes LGTM, tested the Lens field list and everything works as expected

…tor/field_detail.tsx Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>

src/plugins/data_view_field_editor/public/components/field_editor/field_detail.tsx

…tor/field_detail.tsx

kertal

Awesome work, another ON week win 🏅 ! One question, should we render newlines? in this example I've added newlines in the editor with every number, the question is if this should also be rendered in the UI this way

kertal · 2024-03-19T12:10:29Z

one note from my end, multiline support shouldn't block from moving forward here, If it makes sense it could be done in a follow up. Something like this could also lead to edge cases, what would happen if there are lots of multilines like
1\n2\n3\n....

ersin-erdal

ResponseOps (Alerting) changes LGTM

kibana-ci · 2024-03-19T13:38:57Z

💚 Build Succeeded

Buildkite Build
Commit: 3789394

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`aiops`	440	464	+24
`apm`	1626	1650	+24
`cloudSecurityPosture`	410	414	+4
`dataViewFieldEditor`	160	161	+1
`dataViewManagement`	195	219	+24
`dataVisualizer`	628	632	+4
`discover`	750	754	+4
`eventAnnotationListing`	470	474	+4
`lens`	1347	1351	+4
`logsExplorer`	678	682	+4
`slo`	610	614	+4
`unifiedDocViewer`	114	118	+4
`unifiedHistogram`	123	127	+4
total			+109

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/field-utils`	30	40	+10

Async chunks

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

id	before	after	diff
`aiops`	403.2KB	404.5KB	+1.3KB
`apm`	3.2MB	3.2MB	+1.3KB
`dataViewFieldEditor`	173.6KB	175.2KB	+1.6KB
`dataViewManagement`	137.8KB	139.2KB	+1.3KB
`discover`	581.8KB	583.1KB	+1.3KB
`lens`	1.4MB	1.4MB	+1.4KB
`slo`	614.4KB	615.8KB	+1.3KB
`unifiedDocViewer`	58.4KB	60.3KB	+1.9KB
total			+11.5KB

Page load bundle

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

id	before	after	diff
`dataViewFieldEditor`	25.1KB	25.3KB	+289.0B
`dataViews`	49.0KB	49.8KB	+868.0B
`slo`	20.7KB	20.7KB	+1.0B
total			+1.1KB

Unknown metric groups

API count

id	before	after	diff
`@kbn/field-utils`	38	48	+10
`data`	3249	3257	+8
`dataViews`	955	970	+15
total			+33

History

💚 Build #197857 succeeded d81df0d
💔 Build #197853 failed 08a5161
💚 Build #197607 succeeded 697894c
💚 Build #196947 succeeded 351c972
💔 Build #196891 failed 4d08779
💔 Build #196523 failed 1bf3c80

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

cc @jughosta

alexfrancoeur · 2024-03-19T20:50:25Z

❤️ ❤️ ❤️ ❤️

- Follow up for #168577 ## Summary We should probably exclude `customDescription`s from the data view minimal spec as they tend to be long. ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios

- Closes #187075 ## Summary This PR updates data view API docs. `customDescription` was added in #168577 --------- Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: Davis McPhee <davismcphee@hotmail.com>

- Closes elastic#187075 ## Summary This PR updates data view API docs. `customDescription` was added in elastic#168577 --------- Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: Davis McPhee <davismcphee@hotmail.com> (cherry picked from commit cd4a782)

# Backport This will backport the following commits from `main` to `8.15`: - [[Discover] Update data view API docs (#187146)](#187146)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Julia Rechkunova <julia.rechkunova@elastic.co>

[DataViewField] Allow to add a custom description for data view fields

66d8ae1

jughosta self-assigned this Oct 11, 2023

jughosta added 2 commits October 11, 2023 12:06

[DataViewField] Support in Lens

f4ada76

[DataViewField] Fix checks

27b1345

jughosta added 2 commits October 12, 2023 15:35

Merge branch 'main' into custom-field-description

ad9b055

[DataViewField] Move the textarea higher and add validation

0d3a6d1

davismcphee reviewed Oct 20, 2023

View reviewed changes

jughosta added 6 commits December 22, 2023 12:20

Merge remote-tracking branch 'upstream/main' into custom-field-descri…

faf0881

…ption # Conflicts: # src/plugins/data_views/common/data_views/data_view.ts

[Discover] Fix after merge

ac48ff6

[Discover] Update description components

3c4014c

[Discover] Update description on Management page

affe54a

[Discover] Show whole length in the popover

87c560f

[Discover] Fix styles

39be0c9

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

6fc27c0

…fix'

jughosta added 4 commits December 22, 2023 18:41

[Discover] Update tests

e5665d9

Merge remote-tracking branch 'origin/custom-field-description' into c…

4064d72

…ustom-field-description

[Discover] Add tests

24e5127

[Discover] Update tests

c359286

jughosta marked this pull request as ready for review March 11, 2024 18:37

jughosta requested review from a team as code owners March 11, 2024 18:37

jbudz approved these changes Mar 11, 2024

View reviewed changes

Merge branch 'main' into custom-field-description

697894c

mattkime approved these changes Mar 14, 2024

View reviewed changes

davismcphee approved these changes Mar 14, 2024

View reviewed changes

src/plugins/data_view_field_editor/public/components/field_editor/field_detail.tsx Outdated Show resolved Hide resolved

stratoula approved these changes Mar 14, 2024

View reviewed changes

jughosta and others added 2 commits March 15, 2024 13:17

Update src/plugins/data_view_field_editor/public/components/field_edi…

f7ce900

…tor/field_detail.tsx Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>

Merge branch 'main' into custom-field-description

08a5161

jughosta commented Mar 15, 2024

View reviewed changes

src/plugins/data_view_field_editor/public/components/field_editor/field_detail.tsx Outdated Show resolved Hide resolved

Update src/plugins/data_view_field_editor/public/components/field_edi…

d81df0d

…tor/field_detail.tsx

kertal reviewed Mar 18, 2024

View reviewed changes

Merge branch 'main' into custom-field-description

3789394

ersin-erdal approved these changes Mar 19, 2024

View reviewed changes

jughosta merged commit fc2c389 into elastic:main Mar 19, 2024
34 checks passed

jughosta deleted the custom-field-description branch March 19, 2024 16:31

kibanamachine added the v8.14.0 label Mar 19, 2024

jughosta mentioned this pull request Mar 19, 2024

[DataView] Keep only customLabel for data view minimal spec #178983

Merged

1 task

jughosta mentioned this pull request Jun 28, 2024

[Discover] Update data view API docs #187146

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DataViewField] Allow to add a custom description for data view fields #168577

[DataViewField] Allow to add a custom description for data view fields #168577

jughosta commented Oct 11, 2023 •

edited

Loading

mattkime commented Oct 11, 2023 •

edited

Loading

ninoslavmiskovic commented Oct 12, 2023

davismcphee left a comment

teresaalvarezsoler commented Nov 20, 2023

davismcphee commented Nov 20, 2023

jughosta commented Dec 22, 2023

jughosta commented Dec 22, 2023

jughosta commented Dec 22, 2023

jughosta commented Dec 22, 2023

elasticmachine commented Mar 11, 2024

jbudz left a comment

mattkime left a comment

davismcphee left a comment

stratoula left a comment

kertal left a comment

kertal commented Mar 19, 2024

ersin-erdal left a comment

kibana-ci commented Mar 19, 2024

API count

alexfrancoeur commented Mar 19, 2024

[DataViewField] Allow to add a custom description for data view fields #168577

[DataViewField] Allow to add a custom description for data view fields #168577

Conversation

jughosta commented Oct 11, 2023 • edited Loading

Summary

Checklist

mattkime commented Oct 11, 2023 • edited Loading

ninoslavmiskovic commented Oct 12, 2023

davismcphee left a comment

Choose a reason for hiding this comment

teresaalvarezsoler commented Nov 20, 2023

davismcphee commented Nov 20, 2023

jughosta commented Dec 22, 2023

jughosta commented Dec 22, 2023

jughosta commented Dec 22, 2023

jughosta commented Dec 22, 2023

elasticmachine commented Mar 11, 2024

jbudz left a comment

Choose a reason for hiding this comment

mattkime left a comment

Choose a reason for hiding this comment

davismcphee left a comment

Choose a reason for hiding this comment

stratoula left a comment

Choose a reason for hiding this comment

kertal left a comment

Choose a reason for hiding this comment

kertal commented Mar 19, 2024

ersin-erdal left a comment

Choose a reason for hiding this comment

kibana-ci commented Mar 19, 2024

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

History

alexfrancoeur commented Mar 19, 2024

jughosta commented Oct 11, 2023 •

edited

Loading

mattkime commented Oct 11, 2023 •

edited

Loading