[Dashboard][Content Editor] Edit title, description, and tags from dashboard listing page #161399

cqliu1 · 2023-07-06T21:13:29Z

Summary

This enables content editor in dashboard to allow users to edit the title, description, and tags from the listing page.

Jul-06-2023.14-10-00.mp4

The only validation added to this flyout is the duplicate title check. I used the same warning message as the visualize listing page.

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
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)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk	Probability	Severity	Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space.	Low	High	Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks.	High	Low	Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled.	Medium	High	Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

This was checked for breaking API changes and was labeled appropriately

cqliu1 · 2023-07-20T17:22:29Z

Per the discussions in #160256 (comment), I've changed the inspect icon to an iInCircle icon.

I've also added a tooltip when the user has read only permissions.

…fix'

…-fix'

elasticmachine · 2023-07-24T22:46:57Z

Pinging @elastic/kibana-presentation (Team:Presentation)

rshen91

tested locally changes lgtm!!!

ThomThomson

Nice work! I tested this out in chrome and everything works as expected! As a bonus this also works on the Dashboard listing page in security, nice!

Not necessary to fix in this PR, but it looks like both the Visualizations and the Dashboards details viewer stays open on navigation to a different app.

Added one nit.

ThomThomson · 2023-07-25T20:50:34Z

src/plugins/dashboard/public/dashboard_listing/hooks/use_dashboard_listing_table.tsx

+
+                if (!validTitle) {
+                  throw new Error(
+                    i18n.translate('dashboard.dashboardListingEditErrorTitle.duplicateWarning', {


nit: Can we add this to the strings file src/plugins/dashboard/public/dashboard_listing/_dashboard_listing_strings.ts just to be consistent?

ThomThomson · 2023-07-25T20:52:17Z

test/functional/apps/dashboard/group4/dashboard_listing.ts

@@ -200,5 +204,35 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
        expect(onDashboardLandingPage).to.equal(false);
      });
    });
+
+    describe('edit meta data', () => {


Nice functional test addition!

cqliu1 · 2023-07-26T18:13:09Z

packages/kbn-content-management-utils/src/types.ts

@@ -347,7 +347,7 @@ export interface ContentManagementCrudTypes<
  /**
   * Update item params
   */
-  UpdateIn: UpdateIn<ContentType, Attributes, UpdateOptions>;
+  UpdateIn: UpdateIn<ContentType, Partial<Attributes>, UpdateOptions>;


@elastic/kibana-data-discovery I believe this is the only line under your ownership that needs review. I made this a Partial type because updates allow for partial saved object attributes

This LGTM, but @mattkime can you do the final approval since you're most familiar with this?

I'll take a look in a bit. At first glance this should be fine but I need to refresh my memory. I started out overly strict with the idea we could loosen things if needed.

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

…/cqliu1/kibana into dashboard/save-from-listing-page

…rd/save-from-listing-page

sebelga

Thanks for working on this! 👍

I wonder why our team didn't get set as required reviewers for the code changes under packages/content-management 🤔

mattkime

content management changes look good to me.

kibana-ci · 2023-08-07T22:47:33Z

💚 Build Succeeded

Buildkite Build
Commit: 50df486

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`dashboard`	386	387	+1

Async chunks

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

id	before	after	diff
`dashboard`	358.5KB	360.1KB	+1.6KB
`eventAnnotation`	176.3KB	176.7KB	+405.0B
`filesManagement`	89.3KB	89.7KB	+405.0B
`graph`	407.5KB	407.9KB	+405.0B
`maps`	2.8MB	2.8MB	+405.0B
`visualizations`	262.5KB	262.9KB	+405.0B
total			+3.5KB

History

💔 Build #148142 failed a8a24a3
💔 Build #148100 failed 211058a
💔 Build #146921 failed 8676fcd
💚 Build #146164 succeeded 2aa567e
💚 Build #145239 succeeded 07dbbc8
💔 Build #145023 failed d5fb094

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

…shboard listing page (elastic#161399) ## Summary Closes elastic#144481. Closes elastic#160256. This enables content editor in dashboard to allow users to edit the title, description, and tags from the listing page. https://github.com/elastic/kibana/assets/1697105/c2212882-43e3-45cb-83fc-493860857019 The only validation added to this flyout is the duplicate title check. I used the same warning message as the visualize listing page. <img width="600" alt="Screenshot 2023-07-06 at 2 11 38 PM" src="https://github.com/elastic/kibana/assets/1697105/42f7244a-1c4d-47ec-8f66-a98a63eff473"> ### Checklist Delete any items that are not applicable to this PR. - [ ] 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) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [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 - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] 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)) - [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### Risk Matrix Delete this section if it is not applicable to this PR. Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release. When forming the risk matrix, consider some of the following examples and how they may potentially impact the change: | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | Multiple Spaces—unexpected behavior in non-default Kibana Space. | Low | High | Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. | | Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. | High | Low | Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. | | Code should gracefully handle cases when feature X or plugin Y are disabled. | Medium | High | Unit tests will verify that any feature flag or plugin combination still results in our service operational. | | [See more potential risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) | ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

cqliu1 force-pushed the dashboard/save-from-listing-page branch from 6ff1991 to 44cc092 Compare July 12, 2023 20:45

cqliu1 force-pushed the dashboard/save-from-listing-page branch from 3843945 to 9c70164 Compare July 20, 2023 19:35

cqliu1 and others added 11 commits July 24, 2023 14:28

Add content editor to dashboard listing

b6dd4b3

Added content editor validator

c66ff63

Remove unused prop

2acffbb

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

2c40659

…fix'

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

c1b63c9

…-fix'

Fix references

24af52e

Added content editor functional test

7d85ade

Change to iInCircle icon

551d805

Add tooltip in read only mode

02fef98

Add dashboard listing test

37fb3e2

Fix ts errors

6ff19a6

cqliu1 force-pushed the dashboard/save-from-listing-page branch from 2293cb2 to 6ff19a6 Compare July 24, 2023 22:45

cqliu1 marked this pull request as ready for review July 24, 2023 22:46

cqliu1 requested review from a team as code owners July 24, 2023 22:46

cqliu1 added the release_note:enhancement label Jul 24, 2023

Fix jest test

37a6f59

rshen91 approved these changes Jul 25, 2023

View reviewed changes

ThomThomson approved these changes Jul 25, 2023

View reviewed changes

Move string to strings file

a7482ee

cqliu1 commented Jul 26, 2023

View reviewed changes

kibanamachine and others added 4 commits July 26, 2023 18:15

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

d5fb094

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

Fix warning string

45c9328

Merge branch 'dashboard/save-from-listing-page' of https://github.com…

77fbc67

…/cqliu1/kibana into dashboard/save-from-listing-page

Merge branch 'main' of https://github.com/elastic/kibana into dashboa…

07dbbc8

…rd/save-from-listing-page

jughosta requested a review from mattkime July 31, 2023 09:25

sebelga self-requested a review July 31, 2023 11:53

sebelga approved these changes Jul 31, 2023

View reviewed changes

Merge branch 'main' into dashboard/save-from-listing-page

2aa567e

mattkime approved these changes Aug 2, 2023

View reviewed changes

Merge branch 'main' into dashboard/save-from-listing-page

8676fcd

cqliu1 enabled auto-merge (squash) August 2, 2023 18:49

cqliu1 added 3 commits August 7, 2023 12:08

Merge branch 'main' into dashboard/save-from-listing-page

211058a

Fix dashboard_listing test

a8a24a3

Remove exclusive suite

50df486

cqliu1 merged commit dbe8852 into elastic:main Aug 7, 2023

kibanamachine added the backport:skip This commit does not require backporting label Aug 7, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Dashboard][Content Editor] Edit title, description, and tags from dashboard listing page #161399

[Dashboard][Content Editor] Edit title, description, and tags from dashboard listing page #161399

cqliu1 commented Jul 6, 2023 •

edited

Loading

cqliu1 commented Jul 20, 2023

elasticmachine commented Jul 24, 2023

rshen91 left a comment

ThomThomson left a comment

ThomThomson Jul 25, 2023

ThomThomson Jul 25, 2023

cqliu1 Jul 26, 2023 •

edited

Loading

davismcphee Jul 26, 2023

mattkime Jul 26, 2023

sebelga left a comment

mattkime left a comment

kibana-ci commented Aug 7, 2023

[Dashboard][Content Editor] Edit title, description, and tags from dashboard listing page #161399

[Dashboard][Content Editor] Edit title, description, and tags from dashboard listing page #161399

Conversation

cqliu1 commented Jul 6, 2023 • edited Loading

Summary

Checklist

Risk Matrix

For maintainers

cqliu1 commented Jul 20, 2023

elasticmachine commented Jul 24, 2023

rshen91 left a comment

Choose a reason for hiding this comment

ThomThomson left a comment

Choose a reason for hiding this comment

ThomThomson Jul 25, 2023

Choose a reason for hiding this comment

ThomThomson Jul 25, 2023

Choose a reason for hiding this comment

cqliu1 Jul 26, 2023 • edited Loading

Choose a reason for hiding this comment

davismcphee Jul 26, 2023

Choose a reason for hiding this comment

mattkime Jul 26, 2023

Choose a reason for hiding this comment

sebelga left a comment

Choose a reason for hiding this comment

mattkime left a comment

Choose a reason for hiding this comment

kibana-ci commented Aug 7, 2023

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

History

cqliu1 commented Jul 6, 2023 •

edited

Loading

cqliu1 Jul 26, 2023 •

edited

Loading